3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'PageContentSave',
14 'PageContentSaveComplete', 'ArticleDelete'.
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle( $article ) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ( $wgReverseTitle ) {
41 wfReverseTitle( $article );
44 if ( $wgCapitalizeTitle ) {
45 wfCapitalizeTitle( $article );
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle( $article ) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ( $wgReverseTitle ) {
59 wfReverseTitle( $article );
62 if ( $wgCapitalizeTitle ) {
63 wfCapitalizeTitle( $article );
66 # code to actually show the article goes here
68 if ( $wgNotifyArticle ) {
69 wfNotifyArticleShow( $article );
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle( $article ) {
78 if ( Hooks::run( 'ArticleShow', array( &$article ) ) ) {
80 # code to actually show the article goes here
82 Hooks::run( 'ArticleShowComplete', array( &$article ) );
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle( $article ) {
100 function reverseForExport( $article ) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once 'extensions/ReverseTitle.php';
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array( 'someFunction', $someData );
143 $wgHooks['EventName'][] = array( 'someFunction' ); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array( $object, 'someMethod' );
147 $wgHooks['EventName'][] = array( $object, 'someMethod', $someData );
148 $wgHooks['EventName'][] = array( $object ); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction( $param1, $param2 )
157 someFunction( $someData, $param1, $param2 )
160 $object->onEventName( $param1, $param2 )
162 $object->someMethod( $param1, $param2 )
163 # object with method and data
164 $object->someMethod( $someData, $param1, $param2 )
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'TimStarling' );
174 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'brion' );
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * No return value (or null): the hook has operated successfully. Previously,
182 true was required. This is the default since MediaWiki 1.23.
183 * "some string": an error occurred; processing should stop and the error
184 should be shown to the user
185 * false: the hook has successfully done the work necessary and the calling
188 The last result would be for cases where the hook function replaces the main
189 functionality. For example, if you wanted to authenticate users to a custom
190 system (LDAP, another PHP program, whatever), you could do:
192 $wgHooks['UserLogin'][] = array( 'ldapLogin', $ldapServer );
194 function ldapLogin( $username, $password ) {
199 Returning false makes less sense for events where the action is complete, and
200 will normally be ignored.
202 Note that none of the examples made use of create_function() as a way to
203 attach a function to a hook. This is known to cause problems (notably with
204 Special:Version), and should be avoided when at all possible.
208 A calling function or method uses the Hooks::run() function to run the hooks
209 related to a particular event, like so:
215 if ( Hooks::run( 'ArticleProtect', array( &$this, &$wgUser ) ) ) {
216 # protect the article
217 Hooks::run( 'ArticleProtectComplete', array( &$this, &$wgUser ) );
222 Hooks::run() returns true if the calling function should continue processing
223 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
224 error occurred, or one of the hooks handled the action already). Checking the
225 return value matters more for "before" hooks than for "complete" hooks.
227 Hooks::run() was added in MediaWiki 1.18, before that the global function
228 wfRunHooks must be used, which was deprecated in MediaWiki 1.25.
230 Note that hook parameters are passed in an array; this is a necessary
231 inconvenience to make it possible to pass reference values (that can be changed)
232 into the hook code. Also note that earlier versions of wfRunHooks took a
233 variable number of arguments; the array() calling protocol came about after
236 ==Events and parameters==
238 This is a list of known events and parameters; please add to it if you're going
239 to add events to the MediaWiki code.
241 'AbortAutoAccount': DEPRECATED! Create a PreAuthenticationProvider instead.
242 Return false to cancel automated local account creation, where normally
243 authentication against an external auth plugin would be creating a local
245 $user: the User object about to be created (read-only, incomplete)
246 &$abortMsg: out parameter: name of error message to be displayed to user
248 'AbortAutoblock': Return false to cancel an autoblock.
249 $autoblockip: The IP going to be autoblocked.
250 &$block: The block from which the autoblock is coming.
252 'AbortDiffCache': Can be used to cancel the caching of a diff.
253 &$diffEngine: DifferenceEngine object
255 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
256 $editor: The User who made the change.
257 $title: The Title of the page that was edited.
258 $rc: The current RecentChange object.
260 'AbortLogin': DEPRECATED! Create a PreAuthenticationProvider instead.
261 Return false to cancel account login.
262 $user: the User object being authenticated against
263 $password: the password being submitted, not yet checked for validity
264 &$retval: a LoginForm class constant to return from authenticateUserData();
265 default is LoginForm::ABORTED. Note that the client may be using a machine
266 API rather than the HTML user interface.
267 &$msg: the message identifier for abort reason (new in 1.18, not available
270 'AbortNewAccount': DEPRECATED! Create a PreAuthenticationProvider instead.
271 Return false to cancel explicit account creation.
272 $user: the User object about to be created (read-only, incomplete)
273 &$msg: out parameter: HTML to display on abort
274 &$status: out parameter: Status object to return, replaces the older $msg param
276 Create the object with Status::newFatal() to ensure proper API error
277 messages are returned when creating account through API clients.
279 'AbortTalkPageEmailNotification': Return false to cancel talk page email
281 $targetUser: the user whom to send talk page email notification
282 $title: the page title
284 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
285 $name: name of the action
286 &$form: HTMLForm object
287 $article: Article object
289 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
290 Allows to change the fields on the form that will be generated.
291 $name: name of the action
292 &$fields: HTMLForm descriptor array
293 $article: Article object
295 'AddNewAccount': DEPRECATED! Use LocalUserCreated.
296 After a user account is created.
297 $user: the User object that was created. (Parameter added in 1.7)
298 $byEmail: true when account was created "by email" (added in 1.12)
300 'AfterBuildFeedLinks': Executed in OutputPage.php after all feed links (atom, rss,...)
301 are created. Can be used to omit specific feeds from being outputted. You must not use
302 this hook to add feeds, use OutputPage::addFeedLink() instead.
303 &$feedLinks: Array of created feed links
305 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
306 before OutputPage::sendCacheControl() and final ob_end_flush() which
307 will send the buffered output to the client. This allows for last-minute
308 modification of the output within the buffer by using ob_get_clean().
309 $output: The OutputPage object where output() was called
311 'AfterImportPage': When a page import is completed.
312 $title: Title under which the revisions were imported
313 $foreignTitle: ForeignTitle object based on data provided by the XML file
314 $revCount: Number of revisions in the XML file
315 $sRevCount: Number of successfully imported revisions
316 $pageInfo: associative array of page information
318 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
319 just before adding its HTML to parser output.
320 $parser: Parser object that called the hook
321 $ig: Gallery, an object of one of the gallery classes (inheriting from
323 &$html: HTML generated by the gallery
325 'AlternateEdit': Before checking if a user can edit a page and before showing
326 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
327 $editPage: the EditPage object
329 'AlternateEditPreview': Before generating the preview of the page when editing
330 ( EditPage::getPreviewText() ).
331 Return false and set $previewHTML and $parserOutput to output custom page
333 $editPage: the EditPage object
334 &$content: the Content object for the text field from the edit page
335 &$previewHTML: Text to be placed into the page for the preview
336 &$parserOutput: the ParserOutput object for the preview
338 'AlternateUserMailer': Called before mail is sent so that mail could be logged
339 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
340 the regular method of sending mail. Return a string to return a php-mail-error
341 message containing the error. Returning true will continue with sending email
343 $headers: Associative array of headers for the email
344 $to: MailAddress object or array
346 $subject: Subject of the email
347 $body: Body of the message
349 'APIAfterExecute': After calling the execute() method of an API module. Use
350 this to extend core API modules.
351 &$module: Module object
353 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
354 &$main: ApiMain object
356 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
357 authenticate and authorize API clients before executing the module. Return
358 false and set a message to cancel the request.
359 $module: Module object
361 &$message: API message to die with. Specific values accepted depend on the
363 * 1.29+: IApiMessage, Message, string message key, or key+parameters array to
364 pass to ApiBase::dieWithError().
365 * 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap.
366 * Earlier: A key or key+parameters in ApiBase::$messageMap.
368 'APIEditBeforeSave': DEPRECATED! Use EditFilterMergedContent instead.
369 Before saving a page with api.php?action=edit, after
370 processing request parameters. Return false to let the request fail, returning
371 an error message or an <edit result="Failure"> tag if $resultArr was filled.
372 Unlike for example 'EditFilterMergedContent' this also being run on undo.
373 Since MediaWiki 1.25, 'EditFilterMergedContent' can also return error details
374 for the API and it's recommended to use it instead of this hook.
375 $editPage: the EditPage object
376 $text: the text passed to the API. Note that this includes only the single
377 section for section edit, and is not necessarily the final text in case of
378 automatically resolved edit conflicts.
379 &$resultArr: data in this array will be added to the API result
381 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
382 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
383 this hook may cancel the hook to signal that the item is not viewable in the
385 $row: A row of data from ContribsPager. The set of data returned by
386 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
388 $context: An IContextSource implementation.
389 &$feedItem: Set this to a FeedItem instance if the callback can handle the
390 provided row. This is provided to the hook as a null, if it is non null then
391 another callback has already handled the hook.
393 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
394 highlighting, add output to $context->getOutput() and return false.
395 $context: An IContextSource.
396 $text: Text to be highlighted.
397 $mime: MIME type of $text.
398 $format: API format code for $text.
400 'APIGetAllowedParams': Use this hook to modify a module's parameters.
401 &$module: ApiBase Module object
402 &$params: Array of parameters
403 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
405 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
406 Use this hook to modify a module's description.
407 &$module: ApiBase Module object
408 &$desc: String description, or array of description strings
410 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
411 $module: ApiBase Module object
412 &$msg: Array of Message objects
414 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages
416 Use this hook to modify a module's parameter descriptions.
417 &$module: ApiBase Module object
418 &$desc: Array of parameter descriptions
420 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
422 $module: ApiBase Module object
423 &$msg: Array of arrays of Message objects
425 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
426 $module: ApiBase Module object
427 &$help: Array of HTML strings to be joined for the output.
428 $options: Array Options passed to ApiHelp::getHelp
429 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
430 the page and values as for Linker::generateTOC().
432 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
433 module manager. Can be used to conditionally register API modules.
434 $moduleManager: ApiModuleManager Module manager instance
436 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
437 an exception is thrown during API action execution.
438 $apiMain: Calling ApiMain instance.
439 $e: Exception object.
441 'ApiMakeParserOptions': Called from ApiParse and ApiExpandTemplates to allow
442 extensions to adjust the ParserOptions before parsing.
443 $options: ParserOptions object
444 $title: Title to be parsed
445 $params: Parameter array for the API module
446 $module: API module (which is also a ContextSource)
447 &$reset: Set to a ScopedCallback used to reset any hooks after the parse is done.
448 &$suppressCache: Set true if cache should be suppressed.
450 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
451 can alter or append to the array.
452 &$results: array with integer keys to associative arrays. Keys in associative
454 - title: Title object.
455 - redirect from: Title or null.
456 - extract: Description for this result.
457 - extract trimmed: If truthy, the extract will not be trimmed to
458 $wgOpenSearchDescriptionLength.
459 - image: Thumbnail for this result. Value is an array with subkeys 'source'
460 (url), 'width', 'height', 'alt', 'align'.
461 - url: Url for the given title.
463 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
464 module manager. Can be used to conditionally register API query modules.
465 $moduleManager: ApiModuleManager Module manager instance
467 'APIQueryAfterExecute': After calling the execute() method of an
468 action=query submodule. Use this to extend core API modules.
469 &$module: Module object
471 'ApiQueryBaseAfterQuery': Called for (some) API query modules after the
472 database query has returned. An API query module wanting to use this hook
473 should see the ApiQueryBase::select() and ApiQueryBase::processRow()
475 $module: ApiQueryBase module in question
476 $result: ResultWrapper|bool returned from the IDatabase::select()
477 &$hookData: array that was passed to the 'ApiQueryBaseBeforeQuery' hook and
478 will be passed to the 'ApiQueryBaseProcessRow' hook, intended for inter-hook
481 'ApiQueryBaseBeforeQuery': Called for (some) API query modules before a
482 database query is made. WARNING: It would be very easy to misuse this hook and
483 break the module! Any joins added *must* join on a unique key of the target
484 table unless you really know what you're doing. An API query module wanting to
485 use this hook should see the ApiQueryBase::select() and
486 ApiQueryBase::processRow() documentation.
487 $module: ApiQueryBase module in question
488 &$tables: array of tables to be queried
489 &$fields: array of columns to select
490 &$conds: array of WHERE conditionals for query
491 &$query_options: array of options for the database request
492 &$join_conds: join conditions for the tables
493 &$hookData: array that will be passed to the 'ApiQueryBaseAfterQuery' and
494 'ApiQueryBaseProcessRow' hooks, intended for inter-hook communication.
496 'ApiQueryBaseProcessRow': Called for (some) API query modules as each row of
497 the database result is processed. Return false to stop processing the result
498 set. An API query module wanting to use this hook should see the
499 ApiQueryBase::select() and ApiQueryBase::processRow() documentation.
500 $module: ApiQueryBase module in question
501 $row: stdClass Database result row
502 &$data: array to be included in the ApiResult.
503 &$hookData: array that was be passed to the 'ApiQueryBaseBeforeQuery' and
504 'ApiQueryBaseAfterQuery' hooks, intended for inter-hook communication.
506 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
507 an action=query submodule. Use this to extend core API modules.
508 &$module: Module object
509 &$resultPageSet: ApiPageSet object
511 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
512 Use this hook to add custom tokens to prop=info. Every token has an action,
513 which will be used in the intoken parameter and in the output
514 (actiontoken="..."), and a callback function which should return the token, or
515 false if the user isn't allowed to obtain it. The prototype of the callback
516 function is func($pageid, $title), where $pageid is the page ID of the page the
517 token is requested for and $title is the associated Title object. In the hook,
518 just add your callback to the $tokenFunctions array and return true (returning
519 false makes no sense).
520 &$tokenFunctions: array(action => callback)
522 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes
524 Use this hook to add custom tokens to list=recentchanges. Every token has an
525 action, which will be used in the rctoken parameter and in the output
526 (actiontoken="..."), and a callback function which should return the token, or
527 false if the user isn't allowed to obtain it. The prototype of the callback
528 function is func($pageid, $title, $rc), where $pageid is the page ID of the
529 page associated to the revision the token is requested for, $title the
530 associated Title object and $rc the associated RecentChange object. In the
531 hook, just add your callback to the $tokenFunctions array and return true
532 (returning false makes no sense).
533 &$tokenFunctions: array(action => callback)
535 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
536 Use this hook to add custom tokens to prop=revisions. Every token has an
537 action, which will be used in the rvtoken parameter and in the output
538 (actiontoken="..."), and a callback function which should return the token, or
539 false if the user isn't allowed to obtain it. The prototype of the callback
540 function is func($pageid, $title, $rev), where $pageid is the page ID of the
541 page associated to the revision the token is requested for, $title the
542 associated Title object and $rev the associated Revision object. In the hook,
543 just add your callback to the $tokenFunctions array and return true (returning
544 false makes no sense).
545 &$tokenFunctions: array(action => callback)
547 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
548 sites general information.
549 $module: the current ApiQuerySiteInfo module
550 &$results: array of results, add things here
552 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
553 sites statistics information.
554 &$results: array of results, add things here
556 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
557 action=query&meta=tokens. Note that most modules will probably be able to use
558 the 'csrf' token instead of creating their own token types.
559 &$salts: array( type => salt to pass to User::getEditToken() or array of salt
560 and key to pass to Session::getToken() )
562 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
563 Use this hook to add custom token to list=users. Every token has an action,
564 which will be used in the ustoken parameter and in the output
565 (actiontoken="..."), and a callback function which should return the token, or
566 false if the user isn't allowed to obtain it. The prototype of the callback
567 function is func($user) where $user is the User object. In the hook, just add
568 your callback to the $tokenFunctions array and return true (returning false
570 &$tokenFunctions: array(action => callback)
572 'ApiQueryWatchlistExtractOutputData': Extract row data for ApiQueryWatchlist.
573 $module: ApiQueryWatchlist instance
574 $watchedItem: WatchedItem instance
575 $recentChangeInfo: Array of recent change info data
576 &$vals: Associative array of data to be output for the row
578 'ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions': Populate the options
579 to be passed from ApiQueryWatchlist to WatchedItemQueryService.
580 $module: ApiQueryWatchlist instance
581 $params: Array of parameters, as would be returned by $module->extractRequestParams()
582 &$options: Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()
584 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
585 should have its own entry in the $apis array and have a unique name, passed as
586 key for the array that represents the service data. In this data array, the
587 key-value-pair identified by the apiLink key is required.
588 &$apis: array of services
590 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
591 Use this hook to extend action=tokens with new token types.
592 &$tokenTypes: supported token types in format 'type' => callback function
593 used to retrieve this type of tokens.
595 'ApiValidatePassword': Called from ApiValidatePassword.
596 $module: ApiValidatePassword instance.
599 'Article::MissingArticleConditions': Before fetching deletion & move log entries
600 to display a message of a non-existing page being deleted/moved, give extensions
601 a chance to hide their (unrelated) log entries.
602 &$conds: Array of query conditions (all of which have to be met; conditions will
603 AND in the final query)
604 $logTypes: Array of log types being queried
606 'ArticleAfterFetchContent': DEPRECATED! Use ArticleAfterFetchContentObject
608 After fetching content of an article from the database.
609 &$article: the article (object) being loaded from the database
610 &$content: the content (string) of the article
612 'ArticleAfterFetchContentObject': After fetching content of an article from the
614 &$article: the article (object) being loaded from the database
615 &$content: the content of the article, as a Content object
617 'ArticleConfirmDelete': Before writing the confirmation form for article
619 $article: the article (object) being deleted
620 $output: the OutputPage object
621 &$reason: the reason (string) the article is being deleted
623 'ArticleContentOnDiff': Before showing the article content below a diff. Use
624 this to change the content in this area or how it is loaded.
625 $diffEngine: the DifferenceEngine
626 $output: the OutputPage object
628 'ArticleContentViewCustom': Allows to output the text of the article in a
629 different format than wikitext. Note that it is preferable to implement proper
630 handing for a custom data type using the ContentHandler facility.
631 $content: content of the page, as a Content object
632 $title: title of the page
633 $output: reference to $wgOut
635 'ArticleDelete': Before an article is deleted.
636 &$wikiPage: the WikiPage (object) being deleted
637 &$user: the user (object) deleting the article
638 &$reason: the reason (string) the article is being deleted
639 &$error: if the deletion was prohibited, the (raw HTML) error message to display
641 &$status: Status object, modify this to throw an error. Overridden by $error
643 $suppress: Whether this is a suppression deletion or not (added in 1.27)
645 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
646 $title: Title of the article that has been deleted.
647 $outputPage: OutputPage that can be used to append the output.
649 'ArticleDeleteComplete': After an article is deleted.
650 &$wikiPage: the WikiPage that was deleted
651 &$user: the user that deleted the article
652 $reason: the reason the article was deleted
653 $id: id of the article that was deleted
654 $content: the Content of the deleted page (or null, when deleting a broken page)
655 $logEntry: the ManualLogEntry used to record the deletion
656 $archivedRevisionCount: the number of revisions archived during the deletion
658 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
660 &$wikiPage: WikiPage (object) of the user talk page
661 $recipient: User (object) who's talk page was edited
663 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
664 article has been changed.
665 &$wikiPage: the WikiPage (object)
666 &$editInfo: data holder that includes the parser output ($editInfo->output) for
667 that page after the change
668 $changed: bool for if the page was changed
670 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
671 recentchanges table, return false to not delete old entries.
672 &$wikiPage: WikiPage (object) being modified
674 'ArticleFromTitle': when creating an article object from a title object using
675 Wiki::articleFromTitle().
676 &$title: Title (object) used to create the article object
677 &$article: Article (object) that will be returned
678 $context: IContextSource (object)
680 'ArticleInsertComplete': DEPRECATED! Use PageContentInsertComplete.
681 After a new article is created.
682 $wikiPage: WikiPage created
683 $user: User creating the article
685 $summary: Edit summary/comment
686 $isMinor: Whether or not the edit was marked as minor
687 $isWatch: (No longer used)
688 $section: (No longer used)
689 $flags: Flags passed to WikiPage::doEditContent()
690 $revision: New Revision of the article
692 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
693 $targetTitle: target title (object)
694 $destTitle: destination title (object)
696 'ArticlePageDataAfter': After loading data of an article from the database.
697 &$wikiPage: WikiPage (object) whose data were loaded
698 &$row: row (object) returned from the database server
700 'ArticlePageDataBefore': Before loading data of an article from the database.
701 &$wikiPage: WikiPage (object) that data will be loaded
702 &$fields: fields (array) to load from the database
704 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
705 $wikiPage: the WikiPage being saved
706 $popts: parser options to be used for pre-save transformation
708 'ArticleProtect': Before an article is protected.
709 &$wikiPage: the WikiPage being protected
710 &$user: the user doing the protection
711 $protect: Set of restriction keys
712 $reason: Reason for protect
714 'ArticleProtectComplete': After an article is protected.
715 &$wikiPage: the WikiPage that was protected
716 &$user: the user who did the protection
717 $protect: Set of restriction keys
718 $reason: Reason for protect
720 'ArticlePurge': Before executing "&action=purge".
721 &$wikiPage: WikiPage (object) to purge
723 'ArticleRevisionUndeleted': After an article revision is restored.
724 &$title: the article title
725 $revision: the revision
726 $oldPageID: the page ID of the revision when archived (may be null)
728 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
729 revisions of an article.
730 $title: Title object of the article
731 $ids: Ids to set the visibility for
732 $visibilityChangeMap: Map of revision id to oldBits and newBits. This array can be
733 examined to determine exactly what visibility bits have changed for each
734 revision. This array is of the form
735 [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
737 'ArticleRollbackComplete': After an article rollback is completed.
738 $wikiPage: the WikiPage that was edited
739 $user: the user who did the rollback
740 $revision: the revision the page was reverted back to
741 $current: the reverted revision
743 'ArticleSave': DEPRECATED! Use PageContentSave instead.
744 Before an article is saved.
745 $wikiPage: the WikiPage (object) being saved
746 $user: the user (object) saving the article
747 $text: the new article text
748 $summary: the article summary (comment)
753 'ArticleSaveComplete': DEPRECATED! Use PageContentSaveComplete instead.
754 After an article has been updated.
755 $wikiPage: WikiPage modified
756 $user: User performing the modification
758 $summary: Edit summary/comment
759 $isMinor: Whether or not the edit was marked as minor
760 $isWatch: (No longer used)
761 $section: (No longer used)
762 $flags: Flags passed to WikiPage::doEditContent()
763 $revision: New Revision of the article
764 $status: Status object about to be returned by doEditContent()
765 $baseRevId: the rev ID (or false) this edit was based on
766 $undidRevId: the rev ID (or 0) this edit undid
768 'ArticleUndelete': When one or more revisions of an article are restored.
769 &$title: Title corresponding to the article restored
770 $create: Whether or not the restoration caused the page to be created (i.e. it
771 didn't exist before).
772 $comment: The comment associated with the undeletion.
773 $oldPageId: ID of page previously deleted (from archive table)
775 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
776 $pageArchive: the PageArchive object
777 &$logEntry: ManualLogEntry object
778 $user: User who is performing the log action
780 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
781 the user is redirected back to the page.
782 $article: the article
783 &$sectionanchor: The section anchor link (e.g. "#overview" )
784 &$extraq: Extra query parameters which can be added via hooked functions
786 'ArticleViewFooter': After showing the footer section of an ordinary page view
787 $article: Article object
788 $patrolFooterShown: boolean whether patrol footer is shown
790 'ArticleViewHeader': Before the parser cache is about to be tried for article
792 &$article: the article
793 &$pcache: whether to try the parser cache or not
794 &$outputDone: whether the output for this page finished or not. Set to
795 a ParserOutput object to both indicate that the output is done and what
796 parser output was used.
798 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
799 redirect was followed.
800 &$article: target article (object)
802 'AuthChangeFormFields': After converting a field information array obtained
803 from a set of AuthenticationRequest classes into a form descriptor; hooks
804 can tweak the array to change how login etc. forms should look.
805 $requests: array of AuthenticationRequests the fields are created from
806 $fieldInfo: field information array (union of all AuthenticationRequest::getFieldInfo() responses).
807 &$formDescriptor: HTMLForm descriptor. The special key 'weight' can be set
808 to change the order of the fields.
809 $action: one of the AuthManager::ACTION_* constants.
811 'AuthManagerLoginAuthenticateAudit': A login attempt either succeeded or failed
812 for a reason other than misconfiguration or session loss. No return data is
813 accepted; this hook is for auditing only.
814 $response: The MediaWiki\Auth\AuthenticationResponse in either a PASS or FAIL state.
815 $user: The User object being authenticated against, or null if authentication
816 failed before getting that far.
817 $username: A guess at the user name being authenticated, or null if we can't
820 'AuthPluginAutoCreate': DEPRECATED! Use the 'LocalUserCreated' hook instead.
821 Called when creating a local account for an user logged in from an external
822 authentication method.
823 $user: User object created locally
825 'AuthPluginSetup': DEPRECATED! Extensions should be updated to use AuthManager.
826 Update or replace authentication plugin object ($wgAuth). Gives a chance for an
827 extension to set it programmatically to a variable class.
828 &$auth: the $wgAuth object, probably a stub
830 'AutopromoteCondition': Check autopromote condition for user.
831 $type: condition type
834 &$result: result of checking autopromote condition
836 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
837 certain title are fetched.
839 $title: title of the page to which backlinks are sought
840 &$conds: query conditions
842 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
846 'BadImage': When checking against the bad image list. Change $bad and return
847 false to override. If an image is "bad", it is not rendered inline in wiki
848 pages or galleries in category pages.
849 $name: Image name being checked
850 &$bad: Whether or not the image is "bad"
852 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
853 custom HTML after the section. Any uses of the hook need to handle escaping.
854 $template: BaseTemplate
855 $portlet: string portlet name
858 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
859 and returning it for the skin to output. You can add items to the toolbox while
860 still letting the skin make final decisions on skin-specific markup conventions
862 &$sk: The BaseTemplate base skin template
863 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
864 BaseTemplate::makeListItem for details on the format of individual items
865 inside of this array.
867 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
868 "noarticletext-nopermission" at Article::showMissingArticle().
869 $article: article object
871 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
872 override how the redirect is output by modifying, or by returning false, and
873 letting standard HTTP rendering take place.
874 ATTENTION: This hook is likely to be removed soon due to overall design of the
876 $context: IContextSource object
877 &$redirect: string URL, modifiable
879 'BeforeInitialize': Before anything is initialized in
880 MediaWiki::performRequest().
881 &$title: Title being used for request
883 &$output: OutputPage object
885 $request: WebRequest object
886 $mediaWiki: Mediawiki object
888 'BeforePageDisplay': Prior to outputting a page.
889 &$out: OutputPage object
892 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
893 override how the redirect is output by modifying, or by returning false and
894 taking over the output.
895 $out: OutputPage object
896 &$redirect: URL, modifiable
897 &$code: HTTP code (eg '301' or '302'), modifiable
899 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
900 $parser: Parser object
902 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
903 as a key then the file will appear as a broken thumbnail.
904 &$descQuery: query string to add to thumbnail URL
906 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
907 $parser: Parser object
908 $title: title of the template
909 &$skip: skip this template and link it?
910 &$id: the id of the revision being parsed
912 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
913 &$parser: Parser object
914 &$ig: ImageGallery object
916 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
918 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
919 to a newly created user account.
920 &$injected_html: Any HTML to inject after the "logged in" message of a newly
923 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
924 normalizations have been performed, except for the $wgMaxImageArea check.
926 &$params: Array of parameters
927 &$checkImageAreaHookResult: null, set to true or false to override the
928 $wgMaxImageArea check result.
930 'BitmapHandlerTransform': before a file is transformed, gives extension the
931 possibility to transform it themselves
932 $handler: BitmapHandler
934 &$scalerParams: Array with scaler parameters
935 &$mto: null, set to a MediaTransformOutput
937 'BlockIp': Before an IP address or user is blocked.
938 &$block: the Block object about to be saved
939 &$user: the user _doing_ the block (not the one being blocked)
940 &$reason: if the hook is aborted, the error message to be returned in an array
942 'BlockIpComplete': After an IP address or user is blocked.
943 $block: the Block object that was saved
944 $user: the user who did the block (not the one being blocked)
945 $priorBlock: the Block object for the prior block or null if there was none
947 'BookInformation': Before information output on Special:Booksources.
948 $isbn: ISBN to show information for
949 $output: OutputPage object in use
951 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
952 to be able to access the wiki via HTTPS.
953 $ip: The IP address in human-readable form
954 &$canDo: This reference should be set to false if the client may not be able
957 'CanonicalNamespaces': For extensions adding their own namespaces or altering
959 Note that if you need to specify namespace protection or content model for
960 a namespace that is added in a CanonicalNamespaces hook handler, you
961 should do so by altering $wgNamespaceProtection and
962 $wgNamespaceContentModels outside the handler, in top-level scope. The
963 point at which the CanonicalNamespaces hook fires is too late for altering
964 these variables. This applies even if the namespace addition is
965 conditional; it is permissible to declare a content model and protection
966 for a namespace and then decline to actually register it.
967 &$namespaces: Array of namespace numbers with corresponding canonical names
969 'CategoryAfterPageAdded': After a page is added to a category.
970 $category: Category that page was added to
971 $wikiPage: WikiPage that was added
973 'CategoryAfterPageRemoved': After a page is removed from a category.
974 $category: Category that page was removed from
975 $wikiPage: WikiPage that was removed
976 $id: the page ID (original ID in case of page deletions)
978 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
979 &$catpage: CategoryPage instance
981 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
982 in a Category page. Gives extensions the opportunity to batch load any
983 related data about the pages.
984 $type: The category type. Either 'page', 'file' or 'subcat'
985 $res: Query result from DatabaseBase::select()
987 'CategoryViewer::generateLink': Before generating an output link allow
988 extensions opportunity to generate a more specific or relevant link.
989 $type: The category type. Either 'page', 'img' or 'subcat'
990 $title: Title object for the categorized page
991 $html: Requested html content of anchor
992 &$link: Returned value. When set to a non-null value by a hook subscriber
993 this value will be used as the anchor instead of Linker::link
995 'ChangeAuthenticationDataAudit': Called when user changes his password.
996 No return data is accepted; this hook is for auditing only.
997 $req: AuthenticationRequest object describing the change (and target user)
998 $status: StatusValue with the result of the action
1000 'ChangePasswordForm': DEPRECATED! Use AuthChangeFormFields or security levels.
1001 For extensions that need to add a field to the ChangePassword form via the
1003 &$extraFields: An array of arrays that hold fields like would be passed to the
1006 'ChangesListInitRows': Batch process change list rows prior to rendering.
1007 $changesList: ChangesList instance
1008 $rows: The data that will be rendered. May be a ResultWrapper instance or
1011 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
1012 &$changesList: ChangesList instance.
1013 &$articlelink: HTML of link to article (already filled-in).
1014 &$s: HTML of row that is being constructed.
1015 &$rc: RecentChange instance.
1016 $unpatrolled: Whether or not we are showing unpatrolled changes.
1017 $watched: Whether or not the change is watched by the user.
1019 'ChangesListSpecialPageFilters': Called after building form options on pages
1020 inheriting from ChangesListSpecialPage (in core: RecentChanges,
1021 RecentChangesLinked and Watchlist).
1022 $special: ChangesListSpecialPage instance
1023 &$filters: associative array of filter definitions. The keys are the HTML
1024 name/URL parameters. Each key maps to an associative array with a 'msg'
1025 (message key) and a 'default' value.
1027 'ChangesListSpecialPageQuery': Called when building SQL query on pages
1028 inheriting from ChangesListSpecialPage (in core: RecentChanges,
1029 RecentChangesLinked and Watchlist).
1030 $name: name of the special page, e.g. 'Watchlist'
1031 &$tables: array of tables to be queried
1032 &$fields: array of columns to select
1033 &$conds: array of WHERE conditionals for query
1034 &$query_options: array of options for the database request
1035 &$join_conds: join conditions for the tables
1036 $opts: FormOptions for this request
1038 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
1039 removed from all revisions and log entries to which it was applied). This gives
1040 extensions a chance to take it off their books.
1041 $tag: name of the tag
1042 &$status: Status object. Add warnings to this as required. There is no point
1043 setting errors, as the deletion has already been partly carried out by this
1046 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
1047 from the UI (Special:Tags) or via the API. You could use this hook if you want
1048 to reserve a specific "namespace" of tags, or something similar.
1049 $tag: name of the tag
1050 $user: user initiating the action
1051 &$status: Status object. Add your errors using `$status->fatal()` or warnings
1052 using `$status->warning()`. Errors and warnings will be relayed to the user.
1053 If you set an error, the user will be unable to create the tag.
1055 'ChangeTagCanDelete': Tell whether a change tag should be able to be
1056 deleted from the UI (Special:Tags) or via the API. The default is that tags
1057 defined using the ListDefinedTags hook are not allowed to be deleted unless
1058 specifically allowed. If you wish to allow deletion of the tag, set
1059 `$status = Status::newGood()` to allow deletion, and then `return false` from
1060 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
1061 out custom deletion actions.
1062 $tag: name of the tag
1063 $user: user initiating the action
1064 &$status: Status object. See above.
1066 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
1067 uses are in active use.
1068 &$tags: list of all active tags. Append to this array.
1070 'ChangeTagsAfterUpdateTags': Called after tags have been updated with the
1071 ChangeTags::updateTags function. Params:
1072 $addedTags: tags effectively added in the update
1073 $removedTags: tags effectively removed in the update
1074 $prevTags: tags that were present prior to the update
1075 $rc_id: recentchanges table id
1076 $rev_id: revision table id
1077 $log_id: logging table id
1079 $rc: RecentChange being tagged when the tagging accompanies the action or null
1080 $user: User who performed the tagging when the tagging is subsequent to the action or null
1082 'ChangeUserGroups': Called before user groups are changed.
1083 $performer: The User who will perform the change
1084 $user: The User whose groups will be changed
1085 &$add: The groups that will be added
1086 &$remove: The groups that will be removed
1088 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
1089 $collationName: Name of the collation in question
1090 &$collationObject: Null. Replace with a subclass of the Collation class that
1091 implements the collation given in $collationName.
1093 'ConfirmEmailComplete': Called after a user's email has been confirmed
1095 $user: user (object) whose email is being confirmed
1097 'ContentAlterParserOutput': Modify parser output for a given content object.
1098 Called by Content::getParserOutput after parsing has finished. Can be used
1099 for changes that depend on the result of the parsing but have to be done
1100 before LinksUpdate is called (such as adding tracking categories based on
1102 $content: The Content to render
1103 $title: Title of the page, as context
1104 $parserOutput: ParserOutput to manipulate
1106 'ContentGetParserOutput': Customize parser output for a given content object,
1107 called by AbstractContent::getParserOutput. May be used to override the normal
1108 model-specific rendering of page content.
1109 $content: The Content to render
1110 $title: Title of the page, as context
1111 $revId: The revision ID, as context
1112 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1113 the output can only depend on parameters provided to this hook function, not
1115 $generateHtml: boolean, indicating whether full HTML should be generated. If
1116 false, generation of HTML may be skipped, but other information should still
1117 be present in the ParserOutput object.
1118 &$output: ParserOutput, to manipulate or replace
1120 'ContentHandlerDefaultModelFor': Called when the default content model is
1121 determined for a given title. May be used to assign a different model for that
1123 $title: the Title in question
1124 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1126 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1127 a given content model name, but no entry for that model exists in
1129 $modeName: the requested content model name
1130 &$handler: set this to a ContentHandler object, if desired.
1132 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1133 be used on a given page. This is especially useful to prevent some content
1134 models to be used in some special location.
1135 $contentModel: ID of the content model in question
1136 $title: the Title in question.
1137 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1138 Handler functions that modify $ok should generally return false to prevent
1139 further hooks from further modifying $ok.
1141 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1142 &$pager: Pager object for contributions
1143 &$queryInfo: The query for the contribs Pager
1145 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1147 &$data: an array of results of all contribs queries
1148 $pager: The ContribsPager object hooked into
1149 $offset: Index offset, inclusive
1150 $limit: Exact query limit
1151 $descending: Query direction, false for ascending, true for descending
1153 'ContributionsLineEnding': Called before a contributions HTML line is finished
1154 $page: SpecialPage object for contributions
1155 &$ret: the HTML line
1156 $row: the DB row for this line
1157 &$classes: the classes to add to the surrounding <li>
1159 'ContributionsToolLinks': Change tool links above Special:Contributions
1160 $id: User identifier
1161 $title: User page title
1162 &$tools: Array of tool links
1163 $specialPage: SpecialPage instance for context and services. Can be either
1164 SpecialContributions or DeletedContributionsPage. Extensions should type
1165 hint against a generic SpecialPage though.
1167 'ConvertContent': Called by AbstractContent::convert when a conversion to
1168 another content model is requested.
1169 Handler functions that modify $result should generally return false to disable
1170 further attempts at conversion.
1171 $content: The Content object to be converted.
1172 $toModel: The ID of the content model to convert to.
1173 $lossy: boolean indicating whether lossy conversion is allowed.
1174 &$result: Output parameter, in case the handler function wants to provide a
1175 converted Content object. Note that $result->getContentModel() must return
1178 'CustomEditor': When invoking the page editor
1179 Return true to allow the normal editor to be used, or false if implementing
1180 a custom editor, e.g. for a special namespace, etc.
1181 $article: Article being edited
1182 $user: User performing the edit
1184 'DatabaseOraclePostInit': Called after initialising an Oracle database
1185 $db: the DatabaseOracle object
1187 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1188 for Special:DeletedContributions
1189 Similar to ContribsPager::reallyDoQuery
1190 &$data: an array of results of all contribs queries
1191 $pager: The DeletedContribsPager object hooked into
1192 $offset: Index offset, inclusive
1193 $limit: Exact query limit
1194 $descending: Query direction, false for ascending, true for descending
1196 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1198 Similar to ContributionsLineEnding
1199 $page: SpecialPage object for DeletedContributions
1200 &$ret: the HTML line
1201 $row: the DB row for this line
1202 &$classes: the classes to add to the surrounding <li>
1204 'DifferenceEngineAfterLoadNewText': called in DifferenceEngine::loadNewText()
1205 after the new revision's content has been loaded into the class member variable
1206 $differenceEngine->mNewContent but before returning true from this function.
1207 $differenceEngine: DifferenceEngine object
1209 'DifferenceEngineLoadTextAfterNewContentIsLoaded': called in
1210 DifferenceEngine::loadText() after the new revision's content has been loaded
1211 into the class member variable $differenceEngine->mNewContent but before
1212 checking if the variable's value is null.
1213 This hook can be used to inject content into said class member variable.
1214 $differenceEngine: DifferenceEngine object
1216 'DifferenceEngineMarkPatrolledLink': Allows extensions to change the "mark as patrolled" link
1217 which is shown both on the diff header as well as on the bottom of a page, usually
1218 wrapped in a span element which has class="patrollink".
1219 $differenceEngine: DifferenceEngine object
1220 &$markAsPatrolledLink: The "mark as patrolled" link HTML (string)
1221 $rcid: Recent change ID (rc_id) for this change (int)
1223 'DifferenceEngineMarkPatrolledRCID': Allows extensions to possibly change the rcid parameter.
1224 For example the rcid might be set to zero due to the user being the same as the
1225 performer of the change but an extension might still want to show it under certain
1227 &$rcid: rc_id (int) of the change or 0
1228 $differenceEngine: DifferenceEngine object
1229 $change: RecentChange object
1230 $user: User object representing the current user
1232 'DifferenceEngineNewHeader': Allows extensions to change the $newHeader variable, which
1233 contains information about the new revision, such as the revision's author, whether
1234 the revision was marked as a minor edit or not, etc.
1235 $differenceEngine: DifferenceEngine object
1236 &$newHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1237 include things like revision author info, revision comment, RevisionDelete link and more
1238 $formattedRevisionTools: Array containing revision tools, some of which may have
1239 been injected with the DiffRevisionTools hook
1240 $nextlink: String containing the link to the next revision (if any); also included in $newHeader
1241 $rollback: Rollback link (string) to roll this revision back to the previous one, if any
1242 $newminor: String indicating if the new revision was marked as a minor edit
1243 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1244 whether we should show just the diff; passed in as a query string parameter to the
1245 various URLs constructed here (i.e. $nextlink)
1246 $rdel: RevisionDelete link for the new revision, if the current user is allowed
1247 to use the RevisionDelete feature
1248 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1250 'DifferenceEngineOldHeader': Allows extensions to change the $oldHeader variable, which
1251 contains information about the old revision, such as the revision's author, whether
1252 the revision was marked as a minor edit or not, etc.
1253 $differenceEngine: DifferenceEngine object
1254 &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1255 include things like revision author info, revision comment, RevisionDelete link and more
1256 $prevlink: String containing the link to the previous revision (if any); also included in $oldHeader
1257 $oldminor: String indicating if the old revision was marked as a minor edit
1258 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1259 whether we should show just the diff; passed in as a query string parameter to the
1260 various URLs constructed here (i.e. $prevlink)
1261 $ldel: RevisionDelete link for the old revision, if the current user is allowed
1262 to use the RevisionDelete feature
1263 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1265 'DifferenceEngineOldHeaderNoOldRev': Change the $oldHeader variable in cases when
1266 there is no old revision
1267 &$oldHeader: empty string by default
1269 'DifferenceEngineRenderRevisionAddParserOutput': Allows extensions to change the parser output.
1270 Return false to not add parser output via OutputPage's addParserOutput method.
1271 $differenceEngine: DifferenceEngine object
1272 $out: OutputPage object
1273 $parserOutput: ParserOutput object
1274 $wikiPage: WikiPage object
1276 'DifferenceEngineRenderRevisionShowFinalPatrolLink': An extension can hook into this hook
1277 point and return false to not show the final "mark as patrolled" link on the bottom
1279 This hook has no arguments.
1281 'DifferenceEngineShowDiff': Allows extensions to affect the diff text which
1282 eventually gets sent to the OutputPage object.
1283 $differenceEngine: DifferenceEngine object
1285 'DifferenceEngineShowEmptyOldContent': Allows extensions to change the diff table
1286 body (without header) in cases when there is no old revision or the old and new
1287 revisions are identical.
1288 $differenceEngine: DifferenceEngine object
1290 'DifferenceEngineShowDiffPage': Add additional output via the available OutputPage
1291 object into the diff view
1292 $out: OutputPage object
1294 'DifferenceEngineShowDiffPageMaybeShowMissingRevision': called in
1295 DifferenceEngine::showDiffPage() when revision data cannot be loaded.
1296 Return false in order to prevent displaying the missing revision message
1297 (i.e. to prevent DifferenceEngine::showMissingRevision() from being called).
1298 $differenceEngine: DifferenceEngine object
1300 'DiffRevisionTools': Override or extend the revision tools available from the
1301 diff view, i.e. undo, etc.
1302 $newRev: Revision object of the "new" revision
1303 &$links: Array of HTML links
1304 $oldRev: Revision object of the "old" revision (may be null)
1305 $user: Current user object
1307 'DiffViewHeader': Called before diff display
1308 $diff: DifferenceEngine object that's calling
1309 $oldRev: Revision object of the "old" revision (may be null/invalid)
1310 $newRev: Revision object of the "new" revision
1312 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1314 &$article: article (object) being viewed
1315 &$oldid: oldid (int) being viewed
1317 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1318 Override the HTML generated for section edit links
1319 $skin: Skin object rendering the UI
1320 $title: Title object for the title being linked to (may not be the same as
1321 the page title, if the section is included from a template)
1322 $section: The designation of the section being pointed to, to be included in
1323 the link, like "§ion=$section"
1324 $tooltip: The default tooltip. Escape before using.
1325 By default, this is wrapped in the 'editsectionhint' message.
1326 &$result: The HTML to return, prefilled with the default plus whatever other
1327 changes earlier hooks have made
1328 $lang: The language code to use for the link in the wfMessage function
1330 'EditFilter': Perform checks on an edit
1331 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1332 $text: Contents of the edit box
1333 $section: Section being edited
1334 &$error: Error message to return
1335 $summary: Edit summary for page
1337 'EditFilterMerged': DEPRECATED! Use EditFilterMergedContent instead.
1338 Post-section-merge edit filter.
1339 $editor: EditPage instance (object)
1340 $text: content of the edit box
1341 &$error: error message to return
1342 $summary: Edit summary for page
1344 'EditFilterMergedContent': Post-section-merge edit filter.
1345 This may be triggered by the EditPage or any other facility that modifies page
1346 content. Use the $status object to indicate whether the edit should be allowed,
1347 and to provide a reason for disallowing it. Return false to abort the edit, and
1348 true to continue. Returning true if $status->isOK() returns false means "don't
1349 save but continue user interaction", e.g. show the edit form.
1350 $status->apiHookResult can be set to an array to be returned by api.php
1351 action=edit. This is used to deliver captchas.
1352 $context: object implementing the IContextSource interface.
1353 $content: content of the edit box, as a Content object.
1354 $status: Status object to represent errors, etc.
1355 $summary: Edit summary for page
1356 $user: the User object representing the user whois performing the edit.
1357 $minoredit: whether the edit was marked as minor by the user.
1359 'EditFormInitialText': Allows modifying the edit form when editing existing
1361 $editPage: EditPage object
1363 'EditFormPreloadText': Allows population of the edit form when creating
1365 &$text: Text to preload with
1366 &$title: Title object representing the page being created
1368 'EditPage::attemptSave': Called before an article is
1369 saved, that is before WikiPage::doEditContent() is called
1370 $editpage_Obj: the current EditPage object
1372 'EditPage::attemptSave:after': Called after an article save attempt
1373 $editpage_Obj: the current EditPage object
1374 $status: the resulting Status object
1375 $resultDetails: Result details array
1377 'EditPage::importFormData': allow extensions to read additional data
1379 $editpage: EditPage instance
1380 $request: Webrequest
1381 return value is ignored (should always return true)
1383 'EditPage::showEditForm:fields': allows injection of form field into edit form
1384 Return value is ignored (should always return true)
1385 &$editor: the EditPage instance for reference
1386 &$out: an OutputPage instance to write to
1388 'EditPage::showEditForm:initial': before showing the edit form
1389 Return false to halt editing; you'll need to handle error messages, etc.
1390 yourself. Alternatively, modifying $error and returning true will cause the
1391 contents of $error to be echoed at the top of the edit form as wikitext.
1392 Return true without altering $error to allow the edit to proceed.
1393 &$editor: EditPage instance (object)
1394 &$out: an OutputPage instance to write to
1396 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1397 but for the read-only 'view source' variant of the edit form.
1398 Return value is ignored (should always return true)
1399 $editor: EditPage instance (object)
1400 &$out: an OutputPage instance to write to
1402 'EditPage::showStandardInputs:options': allows injection of form fields into
1403 the editOptions area
1404 Return value is ignored (should always be true)
1405 $editor: EditPage instance (object)
1406 $out: an OutputPage instance to write to
1407 &$tabindex: HTML tabindex of the last edit check/button
1409 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1410 when there's an edit conflict. Return false to halt normal diff output; in
1411 this case you're responsible for computing and outputting the entire "conflict"
1412 part, i.e., the "difference between revisions" and "your text" headers and
1414 &$editor: EditPage instance
1415 &$out: OutputPage instance
1417 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1418 textarea in the edit form.
1419 &$editpage: The current EditPage object
1420 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1421 &$tabindex: HTML tabindex of the last edit check/button
1423 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1425 &$editpage: The current EditPage object
1426 &$checks: Array of edit checks like "watch this page"/"minor edit"
1427 &$tabindex: HTML tabindex of the last edit check/button
1429 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1430 textarea in the edit form.
1431 &$toolbar: The toolbar HTMl
1433 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1434 contribution/copyright notice.
1435 $title: title of page being edited
1436 &$msg: localization message name, overridable. Default is either
1437 'copyrightwarning' or 'copyrightwarning2'.
1439 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1440 "Show changes". Note that it is preferable to implement diff handling for
1441 different data types using the ContentHandler facility.
1442 $editPage: EditPage object
1443 &$newtext: wikitext that will be used as "your version"
1445 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1446 previewed. Note that it is preferable to implement previews for different data
1447 types using the ContentHandler facility.
1448 $editPage: EditPage object
1449 &$content: Content object to be previewed (may be replaced by hook function)
1451 'EditPageGetPreviewText': DEPRECATED! Use EditPageGetPreviewContent instead.
1452 Allow modifying the wikitext that will be previewed. Note that it is preferable
1453 to implement previews for different data types using the ContentHandler
1455 $editPage: EditPage object
1456 &$toparse: wikitext that will be parsed
1458 'EditPageNoSuchSection': When a section edit request is given for an
1459 non-existent section
1460 &$editpage: The current EditPage object
1461 &$res: the HTML of the error text
1463 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1464 of terms of service summary link that might exist separately from the copyright
1466 $title: title of page being edited
1467 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1469 'EmailConfirmed': When checking that the user's email address is "confirmed".
1470 This runs before the other checks, such as anonymity and the real check; return
1471 true to allow those checks to occur, and false if checking is done.
1472 &$user: User being checked
1473 &$confirmed: Whether or not the email address is confirmed
1475 'EmailUser': Before sending email from one user to another.
1476 &$to: MailAddress object of receiving user
1477 &$from: MailAddress object of sending user
1478 &$subject: subject of the mail
1479 &$text: text of the mail
1480 &$error: Out-param for an error. Should be set to a Status object or boolean false.
1482 'EmailUserCC': Before sending the copy of the email to the author.
1483 &$to: MailAddress object of receiving user
1484 &$from: MailAddress object of sending user
1485 &$subject: subject of the mail
1486 &$text: text of the mail
1488 'EmailUserComplete': After sending email from one user to another.
1489 $to: MailAddress object of receiving user
1490 $from: MailAddress object of sending user
1491 $subject: subject of the mail
1492 $text: text of the mail
1494 'EmailUserForm': After building the email user form object.
1495 &$form: HTMLForm object
1497 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1499 $user: The user who is trying to email another user.
1500 $editToken: The user's edit token.
1501 &$hookErr: Out-param for the error. Passed as the parameters to
1502 OutputPage::showErrorPage.
1504 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1505 group of changes in EnhancedChangesList.
1506 Hook subscribers can return false to omit this line from recentchanges.
1507 $changesList: EnhancedChangesList object
1508 &$links: The links that were generated by EnhancedChangesList
1509 $block: The RecentChanges objects in that block
1511 'EnhancedChangesListModifyLineData': to alter data used to build
1512 a grouped recent change inner line in EnhancedChangesList.
1513 Hook subscribers can return false to omit this line from recentchanges.
1514 $changesList: EnhancedChangesList object
1515 &$data: An array with all the components that will be joined in order to create the line
1516 $block: An array of RecentChange objects in that block
1517 $rc: The RecentChange object for this line
1518 &$classes: An array of classes to change
1520 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1521 a non-grouped recent change line in EnhancedChangesList.
1522 $changesList: EnhancedChangesList object
1523 &$data: An array with all the components that will be joined in order to create the line
1524 $rc: The RecentChange object for this line
1526 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1528 $ip: The ip address of the user
1530 'ExtensionTypes': Called when generating the extensions credits, use this to
1531 change the tables headers.
1532 &$extTypes: associative array of extensions types
1534 'ExtractThumbParameters': DEPRECATED! Media handler should override
1535 MediaHandler::parseParamString instead.
1536 Called when extracting thumbnail parameters from a thumbnail file name.
1537 $thumbname: the base name of the thumbnail file
1538 &$params: the currently extracted params (has source name, temp or archived
1541 'FetchChangesList': When fetching the ChangesList derivative for a particular
1543 $user: User the list is being fetched for
1544 &$skin: Skin object to be used with the list
1545 &$list: List object (defaults to NULL, change it to an object instance and
1546 return false override the list derivative used)
1548 'FileDeleteComplete': When a file is deleted.
1549 &$file: reference to the deleted file
1550 &$oldimage: in case of the deletion of an old image, the name of the old file
1551 &$article: in case all revisions of the file are deleted a reference to the
1552 WikiFilePage associated with the file.
1553 &$user: user who performed the deletion
1556 'FileTransformed': When a file is transformed and moved into storage.
1557 $file: reference to the File object
1558 $thumb: the MediaTransformOutput object
1559 $tmpThumbPath: The temporary file system path of the transformed file
1560 $thumbPath: The permanent storage path of the transformed file
1562 'FileUndeleteComplete': When a file is undeleted
1563 $title: title object to the file
1564 $fileVersions: array of undeleted versions. Empty if all versions were restored
1565 $user: user who performed the undeletion
1568 'FileUpload': When a file upload occurs.
1569 $file: Image object representing the file that was uploaded
1570 $reupload: Boolean indicating if there was a previously another image there or
1572 $hasDescription: Boolean indicating that there was already a description page
1573 and a new one from the comment wasn't created (since 1.17)
1575 'FormatAutocomments': When an autocomment is formatted by the Linker.
1576 &$comment: Reference to the accumulated comment. Initially null, when set the
1577 default code will be skipped.
1578 $pre: Boolean, true if there is text before this autocomment
1579 $auto: The extracted part of the parsed comment before the call to the hook.
1580 $post: Boolean, true if there is text after this autocomment
1581 $title: An optional title object used to links to sections. Can be null.
1582 $local: Boolean indicating whether section links should refer to local page.
1583 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1584 autocomment originated; null for the local wiki. Added in 1.26, should default
1585 to null in handler functions, for backwards compatibility.
1587 'GalleryGetModes': Get list of classes that can render different modes of a
1589 &$modeArray: An associative array mapping mode names to classes that implement
1590 that mode. It is expected all registered classes are a subclass of
1593 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1595 $user: user to promote.
1596 &$promote: groups that will be added.
1598 'GetBlockedStatus': after loading blocking status of an user from the database
1599 &$user: user (object) being checked
1601 'GetCacheVaryCookies': Get cookies that should vary cache options.
1602 $out: OutputPage object
1603 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1604 that have to vary cache options
1606 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1608 &$title: Title object of page
1609 &$url: string value as output (out parameter, can modify)
1610 $query: query options passed to Title::getCanonicalURL()
1612 'GetDefaultSortkey': Override the default sortkey for a page.
1613 $title: Title object that we need to get a sortkey for
1614 &$sortkey: Sortkey to use.
1616 'GetDifferenceEngine': Called when getting a new difference engine interface
1617 object Return false for valid object in $differenceEngine or true for the
1618 default difference engine.
1619 $context: IContextSource context to be used for diff
1620 $old: Revision ID to show and diff with
1621 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1622 $refreshCache: If set, refreshes the diff cache
1623 $unhide: If set, allow viewing deleted revs
1624 &$differenceEngine: output parameter, difference engine object to be used for
1627 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1628 underscore) magic words. Called by MagicWord.
1629 &$doubleUnderscoreIDs: array of strings
1631 'GetExtendedMetadata': Get extended file metadata for the API
1632 &$combinedMeta: Array of the form:
1633 'MetadataPropName' => array(
1634 value' => prop value,
1635 'source' => 'name of hook'
1637 $file: File object of file in question
1638 $context: RequestContext (including language to use)
1639 $single: Only extract the current language; if false, the prop value should
1640 be in the metadata multi-language array format:
1641 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1642 &$maxCacheTime: how long the results can be cached
1644 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1645 &$title: Title object of page
1646 &$url: string value as output (out parameter, can modify)
1647 $query: query options passed to Title::getFullURL()
1649 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1650 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1652 &$output: string for the output timestamp
1653 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1654 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1655 $user: User whose preferences are being used to make timestamp
1656 $lang: Language that will be used to render the timestamp
1658 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1659 &$title: Title object of page
1660 &$url: string value as output (out parameter, can modify)
1661 $query: query options passed to Title::getInternalURL()
1663 'GetIP': modify the ip of the current user (called only once).
1664 &$ip: string holding the ip as determined so far
1666 'GetLinkColours': modify the CSS class of an array of page links.
1667 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1669 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1671 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1672 working with internal urls (non-interwiki) then it may be preferable to work
1673 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1674 be buggy for internal urls on render if you do not re-implement the horrible
1675 hack that Title::getLocalURL uses in your own extension.
1676 &$title: Title object of page
1677 &$url: string value as output (out parameter, can modify)
1678 $query: query options passed to Title::getLocalURL()
1680 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1681 without any fancy queries or variants.
1682 &$title: Title object of page
1683 &$url: string value as output (out parameter, can modify)
1685 'GetLocalURL::Internal': Modify local URLs to internal pages.
1686 &$title: Title object of page
1687 &$url: string value as output (out parameter, can modify)
1688 $query: query options passed to Title::getLocalURL()
1690 'GetLogTypesOnUser': Add log types where the target is a userpage
1691 &$types: Array of log types
1693 'GetMetadataVersion': Modify the image metadata version currently in use. This
1694 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1695 that need to have versioned metadata should add an element to the end of the
1696 version array of the form 'handler_name=version'. Most media handlers won't need
1697 to do this unless they broke backwards compatibility with a previous version of
1698 the media handler metadata output.
1699 &$version: Array of version strings
1701 'GetNewMessagesAlert': Disable or modify the new messages alert
1702 &$newMessagesAlert: An empty string by default. If the user has new talk page
1703 messages, this should be populated with an alert message to that effect
1704 $newtalks: An empty array if the user has no new messages or an array
1705 containing links and revisions if there are new messages (See
1706 User::getNewMessageLinks)
1707 $user: The user object of the user who is loading the page
1708 $out: OutputPage object (to check what type of page the user is on)
1710 'GetPreferences': Modify user preferences.
1711 $user: User whose preferences are being modified.
1712 &$preferences: Preferences description array, to be fed to an HTMLForm object
1714 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1715 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1717 &$output: string for the output timestamp
1718 &$diff: DateInterval representing the difference between the timestamps
1719 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1720 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1721 $user: User whose preferences are being used to make timestamp
1722 $lang: Language that will be used to render the timestamp
1724 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1725 checked for. Use instead of userCan for most cases. Return false if the user
1726 can't do it, and populate $result with the reason in the form of
1727 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1728 might want to use ApiMessage to provide machine-readable details for the API).
1729 For consistency, error messages
1730 should be plain text with no special coloring, bolding, etc. to show that
1731 they're errors; presenting them properly to the user as errors is done by the
1733 &$title: Title object being checked against
1734 &$user: Current user object
1735 $action: Action being checked
1736 &$result: User permissions error to add. If none, return true.
1738 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1739 called only if expensive checks are enabled. Add a permissions error when
1740 permissions errors are checked for. Return false if the user can't do it, and
1741 populate $result with the reason in the form of array( messagename, param1,
1742 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1743 to provide machine-readable details for the API). For consistency, error
1744 messages should be plain text with no
1745 special coloring, bolding, etc. to show that they're errors; presenting them
1746 properly to the user as errors is done by the caller.
1747 &$title: Title object being checked against
1748 &$user: Current user object
1749 $action: Action being checked
1750 &$result: User permissions error to add. If none, return true.
1752 'GitViewers': Called when generating the list of git viewers for
1753 Special:Version, use this to change the list.
1754 &$extTypes: associative array of repo URLS to viewer URLs.
1756 'HistoryRevisionTools': Override or extend the revision tools available from the
1757 page history view, i.e. undo, rollback, etc.
1758 $rev: Revision object
1759 &$links: Array of HTML links
1760 $prevRev: Revision object, next in line in page history, or null
1761 $user: Current user object
1763 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1765 $context: An IContextSource object with information about the request being
1768 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1769 image insertion. You can skip the default logic entirely by returning false, or
1770 just modify a few things using call-by-reference.
1772 &$title: Title object of the image
1773 &$file: File object, or false if it doesn't exist
1774 &$frameParams: Various parameters with special meanings; see documentation in
1775 includes/Linker.php for Linker::makeImageLink
1776 &$handlerParams: Various parameters with special meanings; see documentation in
1777 includes/Linker.php for Linker::makeImageLink
1778 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1779 &$res: Final HTML output, used if you return false
1781 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1782 the image on an image page.
1783 &$imagePage: ImagePage object ($this)
1786 'ImagePageAfterImageLinks': Called after the image links section on an image
1788 $imagePage: ImagePage object ($this)
1789 &$html: HTML for the hook to add
1791 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1792 $imagePage: ImagePage object ($this)
1794 &$line: the HTML of the history line
1795 &$css: the line CSS class
1797 'ImagePageFindFile': Called when fetching the file associated with an image
1799 $page: ImagePage object
1801 &$displayFile: displayed File object
1803 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1804 $page: ImagePage object
1805 &$toc: Array of <li> strings
1807 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1809 &$title: the Title object of the file as it would appear for the upload page
1810 &$path: the original file and path name when img_auth was invoked by the web
1812 &$name: the name only component of the file
1813 &$result: The location to pass back results of the hook routine (only used if
1815 $result[0]=The index of the header message
1816 $result[1]=The index of the body text message
1817 $result[2 through n]=Parameters passed to body text message. Please note the
1818 header message cannot receive/use parameters.
1820 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1821 Return false to stop further processing of the tag
1822 $reader: XMLReader object
1823 $logInfo: Array of information
1825 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1826 Return false to stop further processing of the tag
1827 $reader: XMLReader object
1828 &$pageInfo: Array of information
1830 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1831 Return false to stop further processing of the tag
1832 $reader: XMLReader object
1833 $pageInfo: Array of page information
1834 $revisionInfo: Array of revision information
1836 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1837 Return false to stop further processing of the tag
1838 $reader: XMLReader object
1840 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1841 Return false to stop further processing of the tag
1842 $reader: XMLReader object
1843 $revisionInfo: Array of information
1845 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1846 and edit summaries for transwiki imports.
1847 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1848 &$pageTitle: String that contains page title.
1850 'ImportSources': Called when reading from the $wgImportSources configuration
1851 variable. Can be used to lazy-load the import sources list.
1852 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1853 comment in DefaultSettings.php for the detail of how to structure this array.
1855 'InfoAction': When building information to display on the action=info page.
1856 $context: IContextSource object
1857 &$pageInfo: Array of information
1859 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1860 &$title: Title object for the current page
1861 &$request: WebRequest
1862 &$ignoreRedirect: boolean to skip redirect check
1863 &$target: Title/string of redirect target
1864 &$article: Article object
1866 'InternalParseBeforeLinks': during Parser's internalParse method before links
1867 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1868 &$parser: Parser object
1869 &$text: string containing partially parsed text
1870 &$stripState: Parser's internal StripState object
1872 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1873 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1874 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1875 template/parser function execution which respect nowiki and HTML-comments.
1876 &$parser: Parser object
1877 &$text: string containing partially parsed text
1878 &$stripState: Parser's internal StripState object
1880 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1881 Return true without providing an interwiki to continue interwiki search.
1882 $prefix: interwiki prefix we are looking for.
1883 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1884 iw_trans and optionally iw_api and iw_wikiid.
1886 'InvalidateEmailComplete': Called after a user's email has been invalidated
1888 $user: user (object) whose email is being invalidated
1890 'IRCLineURL': When constructing the URL to use in an IRC notification.
1891 Callee may modify $url and $query, URL will be constructed as $url . $query
1892 &$url: URL to index.php
1893 &$query: Query string
1894 $rc: RecentChange object that triggered url generation
1896 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1897 &$article: article (object) being checked
1899 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1900 &$ip: IP being check
1901 &$result: Change this value to override the result of IP::isTrustedProxy()
1903 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1904 $url: URL used to upload from
1905 &$allowed: Boolean indicating if uploading is allowed for given URL
1907 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1908 instance to return false if the domain name doesn't match your organization.
1909 $addr: The e-mail address entered by the user
1910 &$result: Set this and return false to override the internal checks
1912 'isValidPassword': Override the result of User::isValidPassword()
1913 $password: The password entered by the user
1914 &$result: Set this and return false to override the internal checks
1915 $user: User the password is being validated for
1917 'Language::getMessagesFileName':
1918 $code: The language code or the language we're looking for a messages file for
1919 &$file: The messages file path, you can override this to change the location.
1921 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1922 $wgExtensionMessagesFiles instead.
1923 Use this to define synonyms of magic words depending of the language
1924 &$magicExtensions: associative array of magic words synonyms
1925 $lang: language code (string)
1927 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1928 remove namespaces. Do not use this hook to add namespaces. Use
1929 CanonicalNamespaces for that.
1930 &$namespaces: Array of namespaces indexed by their numbers
1932 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1933 listed in $wgExtensionMessagesFiles instead.
1934 Use to define aliases of special pages names depending of the language
1935 &$specialPageAliases: associative array of magic words synonyms
1936 $lang: language code (string)
1938 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1939 &$names: array of language code => language name
1940 $code: language of the preferred translations
1942 'LanguageLinks': Manipulate a page's language links. This is called
1943 in various places to allow extensions to define the effective language
1945 $title: The page's Title.
1946 &$links: Array with elements of the form "language:title" in the order
1947 that they will be output.
1948 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1949 Currently unused, but planned to provide support for marking individual
1950 language links in the UI, e.g. for featured articles.
1952 'LanguageSelector': Hook to change the language selector available on a page.
1953 $out: The output page.
1954 $cssClassName: CSS class name of the language selector.
1956 'LinkBegin': DEPRECATED! Use HtmlPageLinkRendererBegin instead.
1957 Used when generating internal and interwiki links in
1958 Linker::link(), before processing starts. Return false to skip default
1959 processing and return $ret. See documentation for Linker::link() for details on
1960 the expected meanings of parameters.
1961 $skin: the Skin object
1962 $target: the Title that the link is pointing to
1963 &$html: the contents that the <a> tag should have (raw HTML); null means
1965 &$customAttribs: the HTML attributes that the <a> tag should have, in
1966 associative array form, with keys and values unescaped. Should be merged
1967 with default values, with a value of false meaning to suppress the
1969 &$query: the query string to add to the generated URL (the bit after the "?"),
1970 in associative array form, with keys and values unescaped.
1971 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1972 &$ret: the value to return if your hook returns false.
1974 'LinkEnd': DEPRECATED! Use HtmlPageLinkRendererEnd hook instead
1975 Used when generating internal and interwiki links in Linker::link(),
1976 just before the function returns a value. If you return true, an <a> element
1977 with HTML attributes $attribs and contents $html will be returned. If you
1978 return false, $ret will be returned.
1979 $skin: the Skin object
1980 $target: the Title object that the link is pointing to
1981 $options: the options. Will always include either 'known' or 'broken', and may
1982 include 'noclasses'.
1983 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1984 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1985 associative array form.
1986 &$ret: the value to return if your hook returns false.
1988 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1990 &$url: the image url
1991 &$alt: the image's alt text
1992 &$img: the new image HTML (if returning false)
1994 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1997 &$text: the link text
1998 &$link: the new link HTML (if returning false)
1999 &$attribs: the attributes to be applied.
2000 $linkType: The external link type
2002 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
2004 $title: the Title object that the link is pointing to
2005 $file: the File object or false if broken link
2006 &$html: the link text
2007 &$attribs: the attributes to be applied
2008 &$ret: the value to return if your hook returns false
2010 'HtmlPageLinkRendererBegin':
2011 Used when generating internal and interwiki links in
2012 LinkRenderer, before processing starts. Return false to skip default
2013 processing and return $ret.
2014 $linkRenderer: the LinkRenderer object
2015 $target: the LinkTarget that the link is pointing to
2016 &$text: the contents that the <a> tag should have; either a plain, unescaped
2017 string or a HtmlArmor object; null means "default".
2018 &$customAttribs: the HTML attributes that the <a> tag should have, in
2019 associative array form, with keys and values unescaped. Should be merged
2020 with default values, with a value of false meaning to suppress the
2022 &$query: the query string to add to the generated URL (the bit after the "?"),
2023 in associative array form, with keys and values unescaped.
2024 &$ret: the value to return if your hook returns false.
2026 'HtmlPageLinkRendererEnd':
2027 Used when generating internal and interwiki links in LinkRenderer,
2028 just before the function returns a value. If you return true, an <a> element
2029 with HTML attributes $attribs and contents $html will be returned. If you
2030 return false, $ret will be returned.
2031 $linkRenderer: the LinkRenderer object
2032 $target: the LinkTarget object that the link is pointing to
2033 $isKnown: boolean indicating whether the page is known or not
2034 &$text: the contents that the <a> tag should have; either a plain, unescaped
2035 string or a HtmlArmor object.
2036 &$attribs: the final HTML attributes of the <a> tag, after processing, in
2037 associative array form.
2038 &$ret: the value to return if your hook returns false.
2040 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
2042 &$linksUpdate: the LinksUpdate object
2044 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
2045 each link table insert. For example, pagelinks, imagelinks, externallinks.
2046 $linksUpdate: LinksUpdate object
2047 $table: the table to insert links to
2048 $insertions: an array of links to insert
2050 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
2051 including delete and insert, has completed for all link tables
2052 &$linksUpdate: the LinksUpdate object
2053 $ticket: prior result of LBFactory::getEmptyTransactionTicket()
2055 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
2056 &$linksUpdate: the LinksUpdate object
2058 'ListDefinedTags': When trying to find all defined tags.
2059 &$tags: The list of tags.
2061 'LoadExtensionSchemaUpdates': Called during database installation and updates.
2062 $updater: A DatabaseUpdater subclass
2064 'LocalFile::getHistory': Called before file history query performed.
2065 &$file: the File object
2067 &$fields: select fields
2069 &$opts: query options
2070 &$join_conds: JOIN conditions
2072 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
2073 $file: the File object
2074 $archiveName: name of an old file version or false if it's the current one
2076 'LocalisationCacheRecache': Called when loading the localisation data into
2078 $cache: The LocalisationCache object
2079 $code: language code
2080 &$alldata: The localisation data from core and extensions
2081 &$purgeBlobs: whether to purge/update the message blobs via
2082 MessageBlobStore::clear()
2084 'LocalisationCacheRecacheFallback': Called for each language when merging
2085 fallback data into the cache.
2086 $cache: The LocalisationCache object
2087 $code: language code
2088 &$alldata: The localisation data from core and extensions. Note some keys may
2089 be omitted if they won't be merged into the final result.
2091 'LocalisationChecksBlacklist': When fetching the blacklist of
2092 localisation checks.
2093 &$blacklist: array of checks to blacklist. See the bottom of
2094 maintenance/language/checkLanguage.inc for the format of this variable.
2096 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
2097 optional localisation messages
2098 &$ignored: Array of ignored message keys
2099 &$optional: Array of optional message keys
2101 'LocalUserCreated': Called when a local user has been created
2102 $user: User object for the created user
2103 $autocreated: Boolean, whether this was an auto-creation
2105 'LogEventsListGetExtraInputs': When getting extra inputs to display on
2106 Special:Log for a specific log type
2107 $type: String of log type being displayed
2108 $logEventsList: LogEventsList object for context and access to the WebRequest
2109 &$input: string HTML of an input element
2111 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
2112 Returning false will prevent the string from being added to the OutputPage.
2113 &$s: html string to show for the log extract
2114 $types: String or Array Log types to show
2115 $page: String or Title The page title to show log entries for
2116 $user: String The user who made the log entries
2117 $param: Associative Array with the following additional options:
2118 - lim Integer Limit of items to show, default is 50
2119 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
2120 - showIfEmpty boolean Set to false if you don't want any output in case the
2121 loglist is empty if set to true (default), "No matching items in log" is
2122 displayed if loglist is empty
2123 - msgKey Array If you want a nice box with a message, set this to the key of
2124 the message. First element is the message key, additional optional elements
2125 are parameters for the key that are processed with
2126 wfMessage()->params()->parseAsBlock()
2127 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
2129 - wrap String Wrap the message in html (usually something like
2130 "<div ...>$1</div>").
2131 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
2133 'LogException': Called before an exception (or PHP error) is logged. This is
2134 meant for integration with external error aggregation services; returning false
2135 will NOT prevent logging.
2136 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
2137 $suppressed: true if the error was suppressed via
2138 error_reporting()/wfSuppressWarnings()
2140 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
2141 error messages. Allows to add additional error messages (except messages already
2142 in LoginForm::$validErrorMessages).
2143 &$messages: Already added messages (inclusive messages from
2144 LoginForm::$validErrorMessages)
2146 'LoginUserMigrated': DEPRECATED! Create a PreAuthenticationProvider instead.
2147 Called during login to allow extensions the opportunity to inform a user that
2148 their username doesn't exist for a specific reason, instead of letting the
2149 login form give the generic error message that the account does not exist. For
2150 example, when the account has been renamed or deleted.
2151 $user: the User object being authenticated against.
2152 &$msg: the message identifier for abort reason, or an array to pass a message
2155 'LogLine': Processes a single log entry on Special:Log.
2156 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
2157 logging.log_type database field.
2158 $log_action: string for the type of log action (e.g. 'delete', 'block',
2159 'create2'). Corresponds to logging.log_action database field.
2160 $title: Title object that corresponds to logging.log_namespace and
2161 logging.log_title database fields.
2162 $paramArray: Array of parameters that corresponds to logging.log_params field.
2163 Note that only $paramArray[0] appears to contain anything.
2164 &$comment: string that corresponds to logging.log_comment database field, and
2165 which is displayed in the UI.
2166 &$revert: string that is displayed in the UI, similar to $comment.
2167 $time: timestamp of the log entry (added in 1.12)
2169 'LonelyPagesQuery': Allow extensions to modify the query used by
2170 Special:LonelyPages.
2171 &$tables: tables to join in the query
2172 &$conds: conditions for the query
2173 &$joinConds: join conditions for the query
2175 'MagicWordwgVariableIDs': When defining new magic words IDs.
2176 &$variableIDs: array of strings
2178 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
2180 $refreshLinks: RefreshLinks object
2182 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
2183 Ideally, this hook should only be used to add variables that depend on
2184 the current page/request; static configuration should be added through
2185 ResourceLoaderGetConfigVars instead.
2186 &$vars: variable (or multiple variables) to be added into the output of
2187 Skin::makeVariablesScript
2188 $out: The OutputPage which called the hook, can be used to get the real title.
2190 'MarkPatrolled': Before an edit is marked patrolled.
2191 $rcid: ID of the revision to be marked patrolled
2192 &$user: the user (object) marking the revision as patrolled
2193 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
2194 sysop in order to mark an edit patrolled.
2195 $auto: true if the edit is being marked as patrolled automatically
2197 'MarkPatrolledComplete': After an edit is marked patrolled.
2198 $rcid: ID of the revision marked as patrolled
2199 &$user: user (object) who marked the edit patrolled
2200 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
2201 sysop to patrol the edit.
2202 $auto: true if the edit is being marked as patrolled automatically
2204 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
2205 something completely different, after the basic globals have been set up, but
2206 before ordinary actions take place.
2208 $article: Article on which the action will be performed
2209 $title: Title on which the action will be performed
2211 $request: $wgRequest
2212 $mediaWiki: The $mediawiki object
2214 'MediaWikiServices': Called when a global MediaWikiServices instance is
2215 initialized. Extensions may use this to define, replace, or wrap services.
2216 However, the preferred way to define a new service is
2217 the $wgServiceWiringFiles array.
2218 $services: MediaWikiServices
2220 'MessageCache::get': When fetching a message. Can be used to override the key
2221 for customisations. Given and returned message key must be in special format:
2222 1) first letter must be in lower case according to the content language.
2223 2) spaces must be replaced with underscores
2224 &$key: message key (string)
2226 'MessageCacheReplace': When a message page is changed. Useful for updating
2228 $title: name of the page changed.
2229 $text: new contents of the page.
2231 'MessagesPreLoad': When loading a message from the database.
2232 $title: title of the message (string)
2233 &$message: value (string), change it to the message you want to define
2234 $code: code (string) denoting the language to try.
2236 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2237 $mimeMagic: Instance of MimeMagic.
2238 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2239 &$tail: More or equal than last 65558 bytes of the file in a string
2240 (in - Do not alter!).
2242 &$mime: MIME type (out).
2244 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2245 MIME type detected by considering the file extension.
2246 $mimeMagic: Instance of MimeMagic.
2247 $ext: File extension.
2248 &$mime: MIME type (in/out).
2250 'MimeMagicInit': Before processing the list mapping MIME types to media types
2251 and the list mapping MIME types to file extensions.
2252 As an extension author, you are encouraged to submit patches to MediaWiki's
2253 core to add new MIME types to mime.types.
2254 $mimeMagic: Instance of MimeMagic.
2255 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2256 for adding new MIME info to the list.
2257 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2258 for adding new MIME types to the list.
2260 'ModifyExportQuery': Modify the query used by the exporter.
2261 $db: The database object to be queried.
2262 &$tables: Tables in the query.
2263 &$conds: Conditions in the query.
2264 &$opts: Options for the query.
2265 &$join_conds: Join conditions for the query.
2267 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2269 $oldTitle: Title object of the current (old) location
2270 $newTitle: Title object of the new location
2271 $user: User making the move
2272 $reason: string of the reason provided by the user
2273 $status: Status object to pass error messages to
2275 'MovePageIsValidMove': Specify whether a page can be moved for technical
2277 $oldTitle: Title object of the current (old) location
2278 $newTitle: Title object of the new location
2279 $status: Status object to pass error messages to
2281 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2283 $index: Integer; the index of the namespace being checked.
2284 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2285 namespace are movable. Hooks may change this value to override the return
2286 value of MWNamespace::isMovable().
2288 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2289 $title: the diff page title (nullable)
2290 &$oldId: the actual old Id to use in the diff
2291 &$newId: the actual new Id to use in the diff (0 means current)
2292 $old: the ?old= param value from the url
2293 $new: the ?new= param value from the url
2295 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2297 $wikiPage: the WikiPage edited
2298 $rev: the new revision
2299 $baseID: the revision ID this was based off, if any
2300 $user: the editing user
2302 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2303 return false to omit the line from RecentChanges and Watchlist special pages.
2304 &$changeslist: The OldChangesList instance.
2305 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2306 $rc: The RecentChange object.
2307 &$classes: array of css classes for the <li> element
2309 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2310 can alter or append to the array of URLs for search & suggestion formats.
2311 &$urls: array of associative arrays with Url element attributes
2313 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2314 when a page view triggers a re-rendering of the page. This may happen
2315 particularly if the parser cache is split by user language, and no cached
2316 rendering of the page exists in the user's language. The hook is called
2317 before checking whether page_links_updated indicates that the links are up
2318 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2319 without triggering any updates.
2320 $page: the Page that was rendered.
2321 $title: the Title of the rendered page.
2322 $parserOutput: ParserOutput resulting from rendering the page.
2324 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2325 users and/or IP addresses too.
2326 &$otherBlockLink: An array with links to other block logs
2327 $ip: The requested IP address or username
2329 'OutputPageBeforeHTML': A page has been processed by the parser and the
2330 resulting HTML is about to be displayed.
2331 &$parserOutput: the parserOutput (object) that corresponds to the page
2332 &$text: the text that will be displayed, in HTML (string)
2334 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2335 body tag to allow for extensions to add attributes to the body of the page they
2336 might need. Or to allow building extensions to add body classes that aren't of
2337 high enough demand to be included in core.
2338 $out: The OutputPage which called the hook, can be used to get the real title
2339 $sk: The Skin that called OutputPage::headElement
2340 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2342 'OutputPageCheckLastModified': when checking if the page has been modified
2343 since the last visit.
2344 &$modifiedTimes: array of timestamps.
2345 The following keys are set: page, user, epoch
2346 $out: OutputPage object (since 1.28)
2348 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2349 categories. Implementations should return false if they generate the category
2350 links, so the default link generation is skipped.
2351 &$out: OutputPage instance (object)
2352 $categories: associative array, keys are category names, values are category
2353 types ("normal" or "hidden")
2354 &$links: array, intended to hold the result. Must be an associative array with
2355 category types as keys and arrays of HTML links as values.
2357 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2358 &$out: OutputPage instance (object)
2359 $parserOutput: parserOutput instance being added in $out
2361 'PageContentInsertComplete': After a new article is created.
2362 $wikiPage: WikiPage created
2363 $user: User creating the article
2364 $content: New content as a Content object
2365 $summary: Edit summary/comment
2366 $isMinor: Whether or not the edit was marked as minor
2367 $isWatch: (No longer used)
2368 $section: (No longer used)
2369 $flags: Flags passed to WikiPage::doEditContent()
2370 $revision: New Revision of the article
2372 'PageContentLanguage': Allows changing the language in which the content of a
2373 page is written. Defaults to the wiki content language ($wgContLang).
2374 $title: Title object
2375 &$pageLang: the page content language (either an object or a language code)
2376 $wgLang: the user language
2378 'PageContentSave': Before an article is saved.
2379 $wikiPage: the WikiPage (object) being saved
2380 $user: the user (object) saving the article
2381 $content: the new article content, as a Content object
2382 $summary: the article summary (comment)
2383 $isminor: minor flag
2384 $iswatch: watch flag
2387 'PageContentSaveComplete': After an article has been updated.
2388 $wikiPage: WikiPage modified
2389 $user: User performing the modification
2390 $content: New content, as a Content object
2391 $summary: Edit summary/comment
2392 $isMinor: Whether or not the edit was marked as minor
2393 $isWatch: (No longer used)
2394 $section: (No longer used)
2395 $flags: Flags passed to WikiPage::doEditContent()
2396 $revision: New Revision of the article (can be null for edits that change
2398 $status: Status object about to be returned by doEditContent()
2399 $baseRevId: the rev ID (or false) this edit was based on
2400 $undidRevId: the rev ID (or 0) this edit undid
2402 'PageHistoryBeforeList': When a history page list is about to be constructed.
2403 &$article: the article that the history is loading for
2404 $context: RequestContext object
2406 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2407 $historyAction: the action object
2408 &$row: the revision row for this line
2409 &$s: the string representing this parsed line
2410 &$classes: array containing the <li> element classes
2412 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2413 any output is generated, to allow batch lookups for prefetching information
2414 needed for display. If the hook handler returns false, the regular behavior of
2415 doBatchLookups() is skipped.
2416 $pager: the PageHistoryPager
2417 $result: a ResultWrapper representing the query result
2419 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2422 &$queryInfo: the query parameters
2424 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2425 which depends on user options should install this hook and append its values to
2427 &$confstr: reference to a hash key string which can be modified
2428 $user: User (object) requesting the page
2429 &$forOptions: array of options the hash is for
2431 'PageViewUpdates': Allow database (or other) changes to be made after a
2432 page view is seen by MediaWiki. Note this does not capture views made
2433 via external caches such as Squid.
2434 $wikipage: WikiPage (object) for the page being viewed.
2435 $user: User (object) for the user who is viewing.
2437 'ParserAfterParse': Called from Parser::parse() just after the call to
2438 Parser::internalParse() returns.
2439 &$parser: parser object
2440 &$text: text being parsed
2441 &$stripState: stripState used (object)
2443 'ParserAfterStrip': Called at end of parsing time.
2444 TODO: No more strip, deprecated ?
2445 &$parser: parser object
2446 &$text: text being parsed
2447 &$stripState: stripState used (object)
2449 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2450 &$parser: Parser object being used
2451 &$text: text that will be returned
2453 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2454 Parser::internalParseHalfParsed()
2455 &$parser: Parser object being used
2456 &$text: text that will be returned
2458 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2459 &$parser: Parser object
2460 &$text: text to parse
2461 &$stripState: StripState instance being used
2463 'ParserBeforeStrip': Called at start of parsing time.
2464 TODO: No more strip, deprecated ?
2465 &$parser: parser object
2466 &$text: text being parsed
2467 &$stripState: stripState used (object)
2469 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2470 &$parser: Parser object being used
2473 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2475 $parserCache: ParserCache object $parserOutput was stored in
2476 $parserOutput: ParserOutput object that was stored
2477 $title: Title of the page that was parsed to generate $parserOutput
2478 $popts: ParserOptions used for generating $parserOutput
2479 $revId: ID of the revision that was parsed to create $parserOutput
2481 'ParserClearState': Called at the end of Parser::clearState().
2482 &$parser: Parser object being cleared
2484 'ParserCloned': Called when the parser is cloned.
2485 $parser: Newly-cloned Parser object
2487 'ParserFetchTemplate': Called when the parser fetches a template
2488 $parser: Parser Parser object or false
2489 $title: Title object of the template to be fetched
2490 $rev: Revision object of the template
2491 &$text: Transclusion text of the template or false or null
2492 &$deps: Array of template dependencies with 'title', 'page_id', 'rev_id' keys
2494 'ParserFirstCallInit': Called when the parser initialises for the first time.
2495 &$parser: Parser object being cleared
2497 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2499 &$parser: Parser object
2500 &$varCache: array to store the value in case of multiples calls of the
2502 &$index: index (string) of the magic
2503 &$ret: value of the magic word (the hook should set it)
2504 &$frame: PPFrame object to use for expanding any template variables
2506 'ParserGetVariableValueTs': Use this to change the value of the time for the
2507 {{LOCAL...}} magic word.
2508 &$parser: Parser object
2509 &$time: actual time (timestamp)
2511 'ParserGetVariableValueVarCache': use this to change the value of the variable
2512 cache or return false to not use it.
2513 &$parser: Parser object
2514 &$varCache: variable cache (array)
2516 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2517 ParserLimitReportFormat instead.
2518 Called at the end of Parser:parse() when the parser will
2519 include comments about size of the text parsed.
2520 $parser: Parser object
2521 &$limitReport: text that will be included (without comment tags)
2523 'ParserLimitReportFormat': Called for each row in the parser limit report that
2524 needs formatting. If nothing handles this hook, the default is to use "$key" to
2525 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2527 $key: Key for the limit report item (string)
2528 &$value: Value of the limit report item
2529 &$report: String onto which to append the data
2530 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2531 text intended for display in a monospaced font.
2532 $localize: If false, $report should be output in English.
2534 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2535 will include comments about size of the text parsed. Hooks should use
2536 $output->setLimitReportData() to populate data. Functions for this hook should
2537 not use $wgLang; do that in ParserLimitReportFormat instead.
2538 $parser: Parser object
2539 $output: ParserOutput object
2541 'ParserMakeImageParams': Called before the parser make an image link, use this
2542 to modify the parameters of the image.
2543 $title: title object representing the file
2544 $file: file object that will be used to create the image
2545 &$params: 2-D array of parameters
2546 $parser: Parser object that called the hook
2548 'ParserSectionCreate': Called each time the parser creates a document section
2549 from wikitext. Use this to apply per-section modifications to HTML (like
2550 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2551 can begin in one section and end in another. Make sure your code can handle
2552 that case gracefully. See the EditSectionClearerLink extension for an example.
2553 $parser: the calling Parser instance
2554 $section: the section number, zero-based, but section 0 is usually empty
2555 &$sectionContent: ref to the content of the section. modify this.
2556 $showEditLinks: boolean describing whether this section has an edit link
2558 'ParserTestGlobals': Allows to define globals for parser tests.
2559 &$globals: Array with all the globals which should be set for parser tests.
2560 The arrays keys serve as the globals names, its values are the globals values.
2562 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2563 run. Use when page save hooks require the presence of custom tables to ensure
2564 that tests continue to run properly.
2565 &$tables: array of table names
2567 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the output is cached.
2568 $page: the WikiPage of the candidate edit
2569 $content: the Content object of the candidate edit
2570 $output: the ParserOutput result of the candidate edit
2571 $summary: the change summary of the candidate edit
2572 $user: the User considering the edit
2574 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2575 $user: User object whose policy you are modifying
2576 &$effectivePolicy: Array of policy statements that apply to this user
2578 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2580 $block: Block object (which is set to be autoblocking)
2581 &$blockIds: Array of block IDs of the autoblock
2583 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2584 my talk page, my contributions" etc).
2585 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2586 &$title: Title object representing the current page
2587 $skin: SkinTemplate object providing context (e.g. to check if the user is
2590 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2591 &$user: User performing the action
2592 $action: Action being performed
2593 &$result: Whether or not the action should be prevented
2594 Change $result and return false to give a definitive answer, otherwise
2595 the built-in rate limiting checks are used, if enabled.
2596 $incrBy: Amount to increment counter by
2598 'PlaceNewSection': Override placement of new sections. Return false and put the
2599 merged text into $text to override the default behavior.
2600 $wikipage: WikiPage object
2601 $oldtext: the text of the article before editing
2602 $subject: subject of the new section
2603 &$text: text of the new section
2605 'PostLoginRedirect': Modify the post login redirect behavior.
2606 Occurs after signing up or logging in, allows for interception of redirect.
2607 &$returnTo: The page name to return to, as a string
2608 &$returnToQuery: array of url parameters, mapping parameter names to values
2609 &$type: type of login redirect as string;
2610 error: display a return to link ignoring $wgRedirectOnLogin
2611 signup: display a return to link using $wgRedirectOnLogin if needed
2612 success: display a return to link using $wgRedirectOnLogin if needed
2613 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2615 'PreferencesFormPreSave': Override preferences being saved
2616 $formData: array of user submitted data
2617 $form: PreferencesForm object, also a ContextSource
2618 $user: User object with preferences to be saved set
2619 &$result: boolean indicating success
2621 'PreferencesGetLegend': Override the text used for the <legend> of a
2622 preferences section.
2623 $form: the PreferencesForm object. This is a ContextSource as well
2624 $key: the section name
2625 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2628 'PrefixSearchBackend': DEPRECATED! Override SearchEngine::completionSearchBackend instead.
2629 Override the title prefix search used for OpenSearch and
2630 AJAX search suggestions. Put results into &$results outparam and return false.
2631 $ns: array of int namespace keys to search in
2632 $search: search term (not guaranteed to be conveniently normalized)
2633 $limit: maximum number of results to return
2634 &$results: out param: array of page names (strings)
2635 $offset: number of results to offset from the beginning
2637 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2638 namespace from the search string so that extensions can attempt it.
2639 &$namespaces: array of int namespace keys to search in (change this if you can
2641 &$search: search term (replace this with term without the namespace if you can
2644 'PrefsEmailAudit': Called when user changes their email address.
2645 $user: User (object) changing his email address
2646 $oldaddr: old email address (string)
2647 $newaddr: new email address (string)
2649 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2651 $article: the title being (un)protected
2652 &$output: a string of the form HTML so far
2654 'ProtectionForm::save': Called when a protection form is submitted.
2655 $article: the Page being (un)protected
2656 &$errorMsg: an html message string of an error or an array of message name and
2658 $reasonstr: a string describing the reason page protection level is altered
2660 'ProtectionForm::showLogExtract': Called after the protection log extract is
2662 $article: the page the form is shown for
2663 $out: OutputPage object
2665 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2667 &$tables: Database tables to be used in the query
2668 &$conds: Conditions to be applied in the query
2669 &$joinConds: Join conditions to be applied in the query
2671 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2672 &$obj: RawAction object
2673 &$text: The text that's going to be the output
2675 'RecentChange_save': Called at the end of RecentChange::save().
2676 &$recentChange: RecentChange object
2678 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2679 names such as "oldid" that are preserved when using redirecting special pages
2680 such as Special:MyPage and Special:MyTalk.
2681 &$redirectParams: An array of parameters preserved by redirecting special pages.
2683 'RejectParserCacheValue': Return false to reject an otherwise usable
2684 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2685 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2687 $parserOutput: ParserOutput value.
2688 $wikiPage: WikiPage object.
2689 $parserOptions: ParserOptions object.
2691 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2692 instance. Can be used by an extension override what skin is used in certain
2694 $context: (IContextSource) The RequestContext the skin is being created for.
2695 &$skin: A variable reference you may set a Skin instance or string key on to
2696 override the skin that will be used for the context.
2698 'RequestHasSameOriginSecurity': Called to determine if the request is somehow
2699 flagged to lack same-origin security. Return false to indicate the lack. Note
2700 if the "somehow" involves HTTP headers, you'll probably need to make sure
2701 the header is varied on.
2702 $request: The WebRequest object.
2704 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2705 $user: The user having their password expiration reset
2706 &$newExpire: The new expiration date
2708 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2709 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2710 to override its behavior. See the module docs for more information.
2711 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2713 $context: ResourceLoaderContext|null
2715 'ResourceLoaderGetConfigVars': Called at the end of
2716 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2717 configuration variables to JavaScript. Things that depend on the current page
2718 or request state must be added through MakeGlobalVariablesScript instead.
2719 &$vars: array( variable name => value )
2721 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2722 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2723 context-based variables.
2724 &$lessVars: array of variables already added
2726 'ResourceLoaderRegisterModules': Right before modules information is required,
2727 such as when responding to a resource
2728 loader request or generating HTML output.
2729 &$resourceLoader: ResourceLoader object
2731 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2732 called after the addition of 'qunit' and MediaWiki testing resources.
2733 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2734 included in core, is fed using tests/qunit/QUnitTestResources.php.
2735 To add a new qunit module named 'myext.tests':
2736 $testModules['qunit']['myext.tests'] = array(
2737 'script' => 'extension/myext/tests.js',
2738 'dependencies' => <any module dependency you might have>
2740 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2741 added to any module.
2742 &$ResourceLoader: object
2744 'RevisionInsertComplete': Called after a revision is inserted into the database.
2745 &$revision: the Revision
2746 $data: the data stored in old_text. The meaning depends on $flags: if external
2747 is set, it's the URL of the revision text in external storage; otherwise,
2748 it's the revision text itself. In either case, if gzip is set, the revision
2750 $flags: a comma-delimited list of strings representing the options used. May
2751 include: utf8 (this will always be set for new revisions); gzip; external.
2753 'SearchableNamespaces': An option to modify which namespaces are searchable.
2754 &$arr: Array of namespaces ($nsId => $name) which will be used.
2756 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2757 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2759 $term: Search term string
2760 &$title: Outparam; set to $title object and return false for a match
2762 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2763 if nothing was found.
2764 $term: Search term string
2765 &$title: Outparam; set to $title object and return false for a match
2767 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2768 the normal operations.
2769 $allSearchTerms: Array of the search terms in all content languages
2770 &$titleResult: Outparam; the value to return. A Title object or null.
2772 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2774 $term: Search term string
2775 &$title: Current Title object that is being returned (null if none found).
2777 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2779 $title: Current Title object being displayed in search results.
2780 &$id: Revision ID (default is false, for latest)
2782 'SearchIndexFields': Add fields to search index mapping.
2783 &$fields: Array of fields, all implement SearchIndexField
2784 $engine: SearchEngine instance for which mapping is being built.
2786 'SearchDataForIndex': Add data to search document. Allows to add any data to
2787 the field map used to index the document.
2788 &$fields: Array of name => value pairs for fields
2789 $handler: ContentHandler for the content being indexed
2790 $page: WikiPage that is being indexed
2791 $output: ParserOutput that is produced from the page
2792 $engine: SearchEngine for which the indexing is intended
2794 'SearchResultsAugment': Allows extension to add its code to the list of search
2796 &$setAugmentors: List of whole-set augmentor objects, must implement ResultSetAugmentor
2797 &$rowAugmentors: List of per-row augmentor objects, must implement ResultAugmentor.
2798 Note that lists should be in the format name => object and the names in both lists should
2801 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2802 perform when page content is modified. Currently called by
2803 AbstractContent::getSecondaryDataUpdates.
2804 $title: Title of the page that is being edited.
2805 $oldContent: Content object representing the page's content before the edit.
2806 $recursive: bool indicating whether DataUpdates should trigger recursive
2807 updates (relevant mostly for LinksUpdate).
2808 $parserOutput: ParserOutput representing the rendered version of the page
2810 &$updates: a list of DataUpdate objects, to be modified or replaced by
2813 'SecuritySensitiveOperationStatus': Affect the return value from
2814 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2815 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2816 constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2817 authentication isn't possible for the current session type.
2818 $operation: (string) The operation being checked.
2819 $session: (MediaWiki\Session\Session) The current session. The
2820 currently-authenticated user may be retrieved as $session->getUser().
2821 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2822 the time of last auth is unknown, or -1 if authentication is not possible.
2824 'SelfLinkBegin': Called before a link to the current article is displayed to
2825 allow the display of the link to be customized.
2826 $nt: the Title object
2827 &$html: html to display for the link
2828 &$trail: optional text to display before $html
2829 &$prefix: optional text to display after $html
2830 &$ret: the value to return if your hook returns false
2832 'SendWatchlistEmailNotification': Return true to send watchlist email
2834 $targetUser: the user whom to send watchlist email notification
2835 $title: the page title
2836 $enotif: EmailNotification object
2838 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2839 loaded from storage. Return false to prevent it from being used.
2840 &$reason: String rejection reason to be logged
2841 $info: MediaWiki\Session\SessionInfo being validated
2842 $request: WebRequest being loaded from
2843 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2844 $data: Array|false Data array for the MediaWiki\Session\Session
2846 'SessionMetadata': Add metadata to a session being saved.
2847 $backend: MediaWiki\Session\SessionBackend being saved.
2848 &$metadata: Array Metadata to be stored. Add new keys here.
2849 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2850 request and 0+ FauxRequests.
2852 'SetupAfterCache': Called in Setup.php, after cache objects are set
2854 'ShortPagesQuery': Allow extensions to modify the query used by
2856 &$tables: tables to join in the query
2857 &$conds: conditions for the query
2858 &$joinConds: join conditions for the query
2859 &$options: options for the query
2861 'ShowMissingArticle': Called when generating the output for a non-existent page.
2862 $article: The article object corresponding to the page
2864 'ShowSearchHit': Customize display of search hit.
2865 $searchPage: The SpecialSearch instance.
2866 $result: The SearchResult to show
2867 $terms: Search terms, for highlighting
2868 &$link: HTML of link to the matching page. May be modified.
2869 &$redirect: HTML of redirect info. May be modified.
2870 &$section: HTML of matching section. May be modified.
2871 &$extract: HTML of content extract. May be modified.
2872 &$score: HTML of score. May be modified.
2873 &$size: HTML of page size. May be modified.
2874 &$date: HTML of of page modification date. May be modified.
2875 &$related: HTML of additional info for the matching page. May be modified.
2876 &$html: May be set to the full HTML that should be used to represent the search
2877 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2878 function returned false.
2880 'ShowSearchHitTitle': Customise display of search hit title/link.
2881 $title: Title to link to
2882 &$text: Text to use for the link
2883 $result: The search result
2884 $terms: The search terms entered
2885 $page: The SpecialSearch object
2886 &$query: Query string to be appended to the link
2888 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2889 Warning: This hook is run on each display. You should consider to use
2890 'SkinBuildSidebar' that is aggressively cached.
2892 &$bar: Sidebar content
2893 Modify $bar to add or modify sidebar portlets.
2895 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2896 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2897 the sitenotice/anonnotice.
2900 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2901 allow the normal method of notice selection/rendering to work, or change the
2902 value of $siteNotice and return false to alter it.
2903 &$siteNotice: HTML returned as the sitenotice
2906 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2908 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2909 the stock bottom scripts.
2911 'SkinAfterContent': Allows extensions to add text after the page content and
2912 article metadata. This hook should work in all skins. Set the &$data variable to
2913 the text you're going to add.
2914 &$data: (string) Text to be printed out directly (without parsing)
2917 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2919 &$bar: Sidebar contents
2920 Modify $bar to add or modify sidebar portlets.
2922 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2924 $title: displayed page title
2925 $type: 'normal' or 'history' for old/diff views
2926 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2927 message must be in HTML format, not wikitext!
2928 &$link: overridable HTML link to be passed into the message as $1
2929 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2932 'SkinEditSectionLinks': Modify the section edit links
2933 $skin: Skin object rendering the UI
2934 $title: Title object for the title being linked to (may not be the same as
2935 the page title, if the section is included from a template)
2936 $section: The designation of the section being pointed to, to be included in
2937 the link, like "§ion=$section"
2938 $tooltip: The default tooltip. Escape before using.
2939 By default, this is wrapped in the 'editsectionhint' message.
2940 &$result: Array containing all link detail arrays. Each link detail array should
2941 contain the following keys:
2942 - targetTitle - Target Title object
2943 - text - String for the text
2944 - attribs - Array of attributes
2945 - query - Array of query parameters to add to the URL
2946 - options - Array of options for Linker::link
2947 $lang: The language code to use for the link in the wfMessage function
2949 'SkinGetPoweredBy': TODO
2950 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2951 the MediaWiki icon but plain text instead.
2954 'SkinPreloadExistence': Supply titles that should be added to link existence
2955 cache before the page is rendered.
2956 &$titles: Array of Title objects
2959 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2960 If false is returned $subpages will be used instead of the HTML
2961 subPageSubtitle() generates.
2962 If true is returned, $subpages will be ignored and the rest of
2963 subPageSubtitle() will run.
2964 &$subpages: Subpage links HTML
2966 $out: OutputPage object
2968 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2970 &$sktemplate: SkinTemplate object
2971 &$nav_urls: array of tabs
2972 &$revid: The revision id of the permanent link
2973 &$revid2: The revision id of the permanent link, second time
2975 'SkinTemplateGetLanguageLink': After building the data for a language link from
2976 which the actual html is constructed.
2977 &$languageLink: array containing data about the link. The following keys can be
2978 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2979 $languageLinkTitle: Title object belonging to the external language link.
2980 $title: Title object of the page the link belongs to.
2981 $outputPage: The OutputPage object the links are built from.
2983 'SkinTemplateNavigation': Called on content pages after the tabs have been
2984 added, but before variants have been added.
2985 &$sktemplate: SkinTemplate object
2986 &$links: Structured navigation links. This is used to alter the navigation for
2987 skins which use buildNavigationUrls such as Vector.
2989 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2990 tab is added but before variants have been added.
2991 &$sktemplate: SkinTemplate object
2992 &$links: Structured navigation links. This is used to alter the navigation for
2993 skins which use buildNavigationUrls such as Vector.
2995 'SkinTemplateNavigation::Universal': Called on both content and special pages
2996 after variants have been added.
2997 &$sktemplate: SkinTemplate object
2998 &$links: Structured navigation links. This is used to alter the navigation for
2999 skins which use buildNavigationUrls such as Vector.
3001 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
3003 &$sktemplate: SkinTemplate object
3004 &$tpl: QuickTemplate engine object
3006 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
3007 &$sktemplate: SkinTemplate object
3008 &$res: set to true to prevent active tabs
3010 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
3011 You can either create your own array, or alter the parameters for
3013 &$sktemplate: The SkinTemplate instance.
3014 $title: Title instance for the page.
3015 $message: Visible label of tab.
3016 $selected: Whether this is a selected tab.
3017 $checkEdit: Whether or not the action=edit query should be added if appropriate.
3018 &$classes: Array of CSS classes to apply.
3019 &$query: Query string to add to link.
3021 &$result: Complete assoc. array if you want to return true.
3023 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
3024 been rendered (useful for adding more).
3025 &$sk: The QuickTemplate based skin template running the hook.
3026 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
3027 extensions that add support for BaseTemplateToolbox should watch for this
3028 dummy parameter with "$dummy=false" in their code and return without echoing
3029 any HTML to avoid creating duplicate toolbox items.
3031 'SoftwareInfo': Called by Special:Version for returning information about the
3033 &$software: The array of software in format 'name' => 'version'. See
3034 SpecialVersion::softwareInformation().
3036 'SpecialBlockModifyFormFields': Add more fields to Special:Block
3037 $sp: SpecialPage object, for context
3038 &$fields: Current HTMLForm fields
3040 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
3041 $id: User id number, only provided for backwards-compatibility
3042 $user: User object representing user contributions are being fetched for
3043 $sp: SpecialPage instance, providing context
3045 'SpecialContributions::formatRow::flags': Called before rendering a
3046 Special:Contributions row.
3047 $context: IContextSource object
3048 $row: Revision information from the database
3049 &$flags: List of flags on this row
3051 'SpecialContributions::getForm::filters': Called with a list of filters to render
3052 on Special:Contributions.
3053 $sp: SpecialContributions object, for context
3054 &$filters: List of filters rendered as HTML
3056 'SpecialListusersDefaultQuery': Called right before the end of
3057 UsersPager::getDefaultQuery().
3058 $pager: The UsersPager instance
3059 &$query: The query array to be returned
3061 'SpecialListusersFormatRow': Called right before the end of
3062 UsersPager::formatRow().
3063 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
3064 $row: Database row object
3066 'SpecialListusersHeader': Called before closing the <fieldset> in
3067 UsersPager::getPageHeader().
3068 $pager: The UsersPager instance
3069 &$out: The header HTML
3071 'SpecialListusersHeaderForm': Called before adding the submit button in
3072 UsersPager::getPageHeader().
3073 $pager: The UsersPager instance
3074 &$out: The header HTML
3076 'SpecialListusersQueryInfo': Called right before the end of.
3077 UsersPager::getQueryInfo()
3078 $pager: The UsersPager instance
3079 &$query: The query array to be returned
3081 'SpecialLogAddLogSearchRelations': Add log relations to the current log
3082 $type: String of the log type
3083 $request: WebRequest object for getting the value provided by the current user
3084 &$qc: Array for query conditions to add
3086 'SpecialMovepageAfterMove': Called after moving a page.
3087 &$movePage: MovePageForm object
3088 &$oldTitle: old title (object)
3089 &$newTitle: new title (object)
3091 'SpecialNewpagesConditions': Called when building sql query for
3093 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
3094 $opts: FormOptions object containing special page options
3095 &$conds: array of WHERE conditionals for query
3096 &$tables: array of tables to be queried
3097 &$fields: array of columns to select
3098 &$join_conds: join conditions for the tables
3100 'SpecialNewPagesFilters': Called after building form options at NewPages.
3101 $special: the special page object
3102 &$filters: associative array of filter definitions. The keys are the HTML
3103 name/URL parameters. Each key maps to an associative array with a 'msg'
3104 (message key) and a 'default' value.
3106 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
3107 this hook to remove a core special page or conditionally register special pages.
3108 &$list: list (array) of core special pages
3110 'SpecialPageAfterExecute': Called after SpecialPage::execute.
3111 $special: the SpecialPage object
3112 $subPage: the subpage string or null if no subpage was specified
3114 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
3115 Return false to prevent execution.
3116 $special: the SpecialPage object
3117 $subPage: the subpage string or null if no subpage was specified
3119 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
3120 $name: name of the special page
3121 &$form: HTMLForm object
3123 'SpecialPasswordResetOnSubmit': When executing a form submission on
3124 Special:PasswordReset.
3125 &$users: array of User objects.
3126 $data: array of data submitted by the user
3127 &$error: string, error code (message key) used to describe to error (out
3128 parameter). The hook needs to return false when setting this, otherwise it
3129 will have no effect.
3131 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
3132 use this to change some selection criteria or substitute a different title.
3133 &$randstr: The random number from wfRandom()
3134 &$isRedir: Boolean, whether to select a redirect or non-redirect
3135 &$namespaces: An array of namespace indexes to get the title from
3136 &$extra: An array of extra SQL statements
3137 &$title: If the hook returns false, a Title object to use instead of the
3138 result from the normal query
3140 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3142 Called after building form options at RecentChanges.
3143 $special: the special page object
3144 &$filters: associative array of filter definitions. The keys are the HTML
3145 name/URL parameters. Each key maps to an associative array with a 'msg'
3146 (message key) and a 'default' value.
3148 'SpecialRecentChangesPanel': Called when building form options in
3149 SpecialRecentChanges.
3150 &$extraOpts: array of added items, to which can be added
3151 $opts: FormOptions for this request
3153 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
3155 Called when building SQL query for SpecialRecentChanges and
3156 SpecialRecentChangesLinked.
3157 &$conds: array of WHERE conditionals for query
3158 &$tables: array of tables to be queried
3159 &$join_conds: join conditions for the tables
3160 $opts: FormOptions for this request
3161 &$query_options: array of options for the database request
3162 &$select: Array of columns to select
3164 'SpecialResetTokensTokens': Called when building token list for
3166 &$tokens: array of token information arrays in the format of
3168 'preference' => '<preference-name>',
3169 'label-message' => '<message-key>',
3172 'SpecialSearchCreateLink': Called when making the message to create a page or
3173 go to the existing page.
3174 $t: title object searched for
3175 &$params: an array of the default message name and page title (as parameter)
3177 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
3178 canceled and a normal search will be performed. Returning true without setting
3179 $url does a standard redirect to $title. Setting $url redirects to the
3181 $term: The string the user searched for
3182 $title: The title the 'go' feature has decided to forward the user to
3183 &$url: Initially null, hook subscribers can set this to specify the final url to redirect to
3185 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
3186 target doesn't exist.
3187 &$title: title object generated from the text entered by the user
3189 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
3190 the advanced form, a.k.a. power search box.
3191 &$showSections: an array to add values with more options to
3192 $term: the search term (not a title object)
3193 $opts: an array of hidden options (containing 'redirs' and 'profile')
3195 'SpecialSearchProfileForm': Allows modification of search profile forms.
3196 $search: special page object
3197 &$form: String: form html
3198 $profile: String: current search profile
3199 $term: String: search term
3200 $opts: Array: key => value of hidden options for inclusion in custom forms
3202 'SpecialSearchProfiles': Allows modification of search profiles.
3203 &$profiles: profiles, which can be modified.
3205 'SpecialSearchResults': Called before search result display
3206 $term: string of search term
3207 $titleMatches: empty or SearchResultSet object
3208 $textMatches: empty or SearchResultSet object
3210 'SpecialSearchResultsPrepend': Called immediately before returning HTML
3211 on the search results page. Useful for including an external search
3212 provider. To disable the output of MediaWiki search output, return
3214 $specialSearch: SpecialSearch object ($this)
3216 $term: Search term specified by the user
3218 'SpecialSearchResultsAppend': Called immediately before returning HTML
3219 on the search results page. Useful for including a feedback link.
3220 $specialSearch: SpecialSearch object ($this)
3222 $term: Search term specified by the user
3224 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3225 $search: SpecialSearch special page object
3226 $profile: String: current search profile
3227 $engine: the search engine
3229 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3230 &$extraStats: Array to save the new stats
3231 $extraStats['<name of statistic>'] => <value>;
3232 <value> can be an array with the keys "name" and "number":
3233 "name" is the HTML to be displayed in the name column
3234 "number" is the number to be displayed.
3235 or, <value> can be the number to be displayed and <name> is the
3236 message key to use in the name column,
3237 $context: IContextSource object
3239 'SpecialTrackingCategories::preprocess': Called after LinkBatch on Special:TrackingCategories
3240 $specialPage: The SpecialTrackingCategories object
3241 $trackingCategories: Array of data from Special:TrackingCategories with msg and cats
3243 'SpecialTrackingCategories::generateCatLink': Called for each cat link on Special:TrackingCategories
3244 $specialPage: The SpecialTrackingCategories object
3245 $catTitle: The Title object of the linked category
3246 &$html: The Result html
3248 'SpecialUploadComplete': Called after successfully uploading a file from
3250 &$form: The SpecialUpload object
3252 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3253 $wgVersion: Current $wgVersion for you to use
3254 &$versionUrl: Raw url to link to (eg: release notes)
3256 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3258 Called after building form options at Watchlist.
3259 $special: the special page object
3260 &$filters: associative array of filter definitions. The keys are the HTML
3261 name/URL parameters. Each key maps to an associative array with a 'msg'
3262 (message key) and a 'default' value.
3264 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3265 SpecialWatchlist. Allows extensions to register custom values they have
3266 inserted to rc_type so they can be returned as part of the watchlist.
3267 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3269 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
3270 Called when building sql query for SpecialWatchlist.
3271 &$conds: array of WHERE conditionals for query
3272 &$tables: array of tables to be queried
3273 &$join_conds: join conditions for the tables
3274 &$fields: array of query fields
3275 $opts: A FormOptions object with watchlist options for the current request
3277 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3278 URL for a title when we have no other parameters on the URL. Gives a chance for
3279 extensions that alter page view behavior radically to abort that redirect or
3281 $request: WebRequest
3282 $title: Title of the currently found title obj
3283 $output: OutputPage object
3285 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3286 rendered (by ThumbnailImage:toHtml method).
3287 $thumbnail: the ThumbnailImage object
3288 &$attribs: image attribute array
3289 &$linkAttribs: image link attribute array
3291 'TitleArrayFromResult': Called when creating an TitleArray object from a
3293 &$titleArray: set this to an object to override the default object returned
3294 $res: database result used to create the object
3296 'TitleExists': Called when determining whether a page exists at a given title.
3297 $title: The title being tested.
3298 &$exists: Whether the title exists.
3300 'TitleGetEditNotices': Allows extensions to add edit notices
3301 $title: The Title object for the page the edit notices are for
3302 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3303 &$notices: Array of notices. Keys are i18n message keys, values are
3304 parseAsBlock()ed messages.
3306 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3307 that can be applied.
3308 $title: The title in question.
3309 &$types: The types of protection available.
3311 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3312 overriding default behavior for determining if a page exists. If $isKnown is
3313 kept as null, regular checks happen. If it's a boolean, this value is returned
3314 by the isKnown method.
3315 $title: Title object that is being checked
3316 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3318 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3319 Called when determining if a page is a CSS or JS page.
3320 $title: Title object that is being checked
3321 &$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
3322 Hooks may change this value to override the return value of
3323 Title::isCssOrJsPage().
3325 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3326 that this hook is not called for interwiki pages or pages in immovable
3327 namespaces: for these, isMovable() always returns false.
3328 $title: Title object that is being checked
3329 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3330 Hooks may change this value to override the return value of
3333 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3334 Called when determining if a page is a wikitext or should
3335 be handled by separate handler (via ArticleViewCustom).
3336 $title: Title object that is being checked
3337 &$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
3338 Hooks may change this value to override the return value of
3339 Title::isWikitextPage()
3341 'TitleMove': Before moving an article (title).
3344 $user: user who does the move
3346 'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
3349 $user: user who does the move
3351 'TitleMoveComplete': After moving an article (title), post-commit.
3354 &$user: user who did the move
3355 $pageid: database ID of the page that's been moved
3356 $redirid: database ID of the created redirect
3357 $reason: reason for the move
3358 $revision: the Revision created by the move
3360 'TitleMoveCompleting': After moving an article (title), pre-commit.
3363 $user: user who did the move
3364 $pageid: database ID of the page that's been moved
3365 $redirid: database ID of the created redirect
3366 $reason: reason for the move
3367 $revision: the Revision created by the move
3369 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3370 or override the quick permissions check.
3371 $title: The Title object being accessed
3372 $user: The User performing the action
3373 $action: Action being performed
3374 &$errors: Array of errors
3375 $doExpensiveQueries: Whether to do expensive DB queries
3376 $short: Whether to return immediately on first error
3378 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3379 adding the default error message if nothing allows the user to read the page. If
3380 a handler wants a title to *not* be whitelisted, it should also return false.
3381 $title: Title object being checked against
3382 $user: Current user object
3383 &$whitelisted: Boolean value of whether this title is whitelisted
3385 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3386 $title: Title object to purge
3387 &$urls: An array of URLs to purge from the caches, to be manipulated.
3389 'UnblockUser': Before an IP address or user is unblocked.
3390 &$block: The Block object about to be saved
3391 &$user: The user performing the unblock (not the one being unblocked)
3392 &$reason: If the hook is aborted, the error message to be returned in an array
3394 'UnblockUserComplete': After an IP address or user has been unblocked.
3395 $block: The Block object that was saved
3396 $user: The user who performed the unblock (not the one being unblocked)
3398 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3399 PageArchive object has been created but before any further processing is done.
3400 &$archive: PageArchive object
3401 $title: Title object of the page that we're viewing
3403 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3404 PageArchive object has been created but before any further processing is done.
3405 &$archive: PageArchive object
3406 $title: Title object of the page that we're viewing
3408 'UndeleteForm::undelete': Called in UndeleteForm::undelete, after checking that
3409 the site is not in read-only mode, that the Title object is not null and after
3410 a PageArchive object has been constructed but before performing any further
3412 &$archive: PageArchive object
3413 $title: Title object of the page that we're about to undelete
3415 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3416 $title: title object related to the revision
3417 $rev: revision (object) that will be viewed
3419 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3420 Since 1.24: Paths pointing to a directory will be recursively scanned for
3421 test case files matching the suffix "Test.php".
3422 &$paths: list of test cases and directories to search.
3424 'UnknownAction': DEPRECATED! To add an action in an extension,
3425 create a subclass of Action, and add a new key to $wgActions.
3426 An unknown "action" has occurred (useful for defining your own actions).
3427 $action: action name
3428 $article: article "acted on"
3430 'UnwatchArticle': Before a watch is removed from an article.
3431 &$user: user watching
3432 &$page: WikiPage object to be removed
3433 &$status: Status object to be returned if the hook returns false
3435 'UnwatchArticleComplete': After a watch is removed from an article.
3436 $user: user that watched
3437 &$page: WikiPage object that was watched
3439 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3440 &$formattedPageStatus: list of valid page states
3442 'UploadComplete': Upon completion of a file upload.
3443 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3444 $uploadBase->getLocalFile().
3446 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3447 $type: (string) the requested upload type
3448 &$className: the class name of the Upload instance to be created
3450 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3451 poke at member variables like $mUploadDescription before the file is saved. Do
3452 not use this hook to break upload processing. This will return the user to a
3453 blank form with no error message; use UploadVerification and UploadVerifyFile
3455 &$form: UploadForm object
3457 'UploadForm:initial': Before the upload form is generated. You might set the
3458 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3459 text (HTML) either before or after the editform.
3460 &$form: UploadForm object
3462 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3464 &$descriptor: (array) the HTMLForm descriptor
3466 'UploadFormSourceDescriptors': after the standard source inputs have been
3467 added to the descriptor
3468 &$descriptor: (array) the HTMLForm descriptor
3469 &$radio: Boolean, if source type should be shown as radio button
3470 $selectedSourceType: The selected source type
3472 'UploadStashFile': Before a file is stashed (uploaded to stash).
3473 Note that code which has not been updated for MediaWiki 1.28 may not call this
3474 hook. If your extension absolutely, positively must prevent some files from
3475 being uploaded, use UploadVerifyFile or UploadVerifyUpload.
3476 $upload: (object) An instance of UploadBase, with all info about the upload
3477 $user: (object) An instance of User, the user uploading this file
3478 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3479 &$error: output: If the file stashing should be prevented, set this to the reason
3480 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3481 instance (you might want to use ApiMessage to provide machine-readable details
3484 'UploadVerification': DEPRECATED! Use UploadVerifyFile instead.
3485 Additional chances to reject an uploaded file.
3486 $saveName: (string) destination file name
3487 $tempName: (string) filesystem path to the temporary file for checks
3488 &$error: (string) output: message key for message to show if upload canceled by
3489 returning false. May also be an array, where the first element is the message
3490 key and the remaining elements are used as parameters to the message.
3492 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3493 in most cases over UploadVerification.
3494 $upload: (object) an instance of UploadBase, with all info about the upload
3495 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3496 Handlers will typically only apply for specific MIME types.
3497 &$error: (object) output: true if the file is valid. Otherwise, set this to the reason
3498 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3499 instance (you might want to use ApiMessage to provide machine-readable details
3502 'UploadVerifyUpload': Upload verification, based on both file properties like
3503 MIME type (same as UploadVerifyFile) and the information entered by the user
3504 (upload comment, file page contents etc.).
3505 $upload: (object) An instance of UploadBase, with all info about the upload
3506 $user: (object) An instance of User, the user uploading this file
3507 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3508 $comment: (string) Upload log comment (also used as edit summary)
3509 $pageText: (string) File description page text (only used for new uploads)
3510 &$error: output: If the file upload should be prevented, set this to the reason
3511 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3512 instance (you might want to use ApiMessage to provide machine-readable details
3515 'UserIsBot': when determining whether a user is a bot account
3517 &$isBot: whether this is user a bot or not (boolean)
3519 'User::mailPasswordInternal': before creation and mailing of a user's new
3521 &$user: the user who sent the message out
3522 &$ip: IP of the user who sent the message out
3523 &$u: the account whose new password will be set
3525 'UserAddGroup': Called when adding a group; return false to override
3526 stock group addition.
3527 $user: the user object that is to have a group added
3528 &$group: the group to add, can be modified
3530 'UserArrayFromResult': Called when creating an UserArray object from a database
3532 &$userArray: set this to an object to override the default object returned
3533 $res: database result used to create the object
3535 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3536 want to display an error message, try getUserPermissionsErrors.
3537 &$title: Title object being checked against
3538 &$user: Current user object
3539 $action: Action being checked
3540 &$result: Pointer to result returned if hook returns false. If null is returned,
3541 userCan checks are continued by internal code.
3543 'UserCanSendEmail': To override User::canSendEmail() permission check.
3544 &$user: User (object) whose permission is being checked
3545 &$canSend: bool set on input, can override on output
3547 'UserClearNewTalkNotification': Called when clearing the "You have new
3548 messages!" message, return false to not delete it.
3549 &$user: User (object) that will clear the message
3550 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3552 'UserCreateForm': DEPRECATED! Create an AuthenticationProvider instead.
3553 Manipulate the login form.
3554 &$template: SimpleTemplate instance for the form
3556 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3557 &$user: User to get groups for
3558 &$groups: Current effective groups
3560 'UserGetAllRights': After calculating a list of all available rights.
3561 &$rights: Array of rights, which may be added to.
3563 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3564 before returning the options to the caller. Warning: This hook is called for
3565 every call to User::getDefaultOptions(), which means it's potentially called
3566 dozens or hundreds of times. You may want to cache the results of non-trivial
3567 operations in your hook function for this reason.
3568 &$defaultOptions: Array of preference keys and their default values.
3570 'UserGetEmail': Called when getting an user email address.
3572 &$email: email, change this to override local email
3574 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3575 email authentication.
3577 &$timestamp: timestamp, change this to override local email authentication
3580 'UserGetImplicitGroups': DEPRECATED!
3581 Called in User::getImplicitGroups().
3582 &$groups: List of implicit (automatically-assigned) groups
3584 'UserGetLanguageObject': Called when getting user's interface language object.
3586 &$code: Language code that will be used to create the object
3587 $context: IContextSource object
3589 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3590 &$reservedUsernames: $wgReservedUsernames
3592 'UserGetRights': Called in User::getRights().
3593 $user: User to get rights for
3594 &$rights: Current rights
3596 'UserGroupsChanged': Called after user groups are changed.
3597 $user: User whose groups changed
3598 $added: Groups added
3599 $removed: Groups removed
3600 $performer: User who performed the change, false if via autopromotion
3601 $reason: The reason, if any, given by the user performing the change,
3602 false if via autopromotion.
3604 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3605 specific block exemptions).
3606 $user: User in question
3607 $title: Title of the page in question
3608 &$blocked: Out-param, whether or not the user is blocked from that page.
3609 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3610 to edit their own user talk pages.
3612 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3614 $ip: User's IP address
3615 &$blocked: Whether the user is blocked, to be modified by the hook
3616 &$block: The Block object, to be modified by the hook
3618 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3619 false if a UserGetRights hook might remove the named right.
3620 $right: The user right being checked
3622 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3623 $user: User in question.
3624 &$hidden: Set true if the user's name should be hidden.
3626 'UserIsLocked': Check if the user is locked. See User::isLocked().
3627 $user: User in question.
3628 &$locked: Set true if the user should be locked.
3630 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3631 environmental means; occurs after session is loaded.
3632 $user: user object being loaded
3634 'UserLoadDefaults': Called when loading a default user.
3638 'UserLoadFromDatabase': Called when loading a user from the database.
3640 &$s: database query object
3642 'UserLoadFromSession': DEPRECATED! Create a MediaWiki\Session\SessionProvider instead.
3643 Called to authenticate users on external/environmental means; occurs before
3645 $user: user object being loaded
3646 &$result: set this to a boolean value to abort the normal authentication
3649 'UserLoadOptions': When user options/preferences are being loaded from the
3652 &$options: Options, can be modified.
3654 'UserLoggedIn': Called after a user is logged in
3655 $user: User object for the logged-in user
3657 'UserLoginComplete': Show custom content after a user has logged in via the web interface.
3658 For functionality that needs to run after any login (API or web) use UserLoggedIn.
3659 &$user: the user object that was created on login
3660 &$inject_html: Any HTML to inject after the "logged in" message.
3661 $direct: (bool) The hook is called directly after a successful login. This will only happen once
3662 per login. A UserLoginComplete call with direct=false can happen when the user visits the login
3663 page while already logged in.
3665 'UserLoginForm': DEPRECATED! Create an AuthenticationProvider instead.
3666 Manipulate the login form.
3667 &$template: QuickTemplate instance for the form
3669 'UserLogout': Before a user logs out.
3670 &$user: the user object that is about to be logged out
3672 'UserLogoutComplete': After a user has logged out.
3673 &$user: the user object _after_ logout (won't have name, ID, etc.)
3674 &$inject_html: Any HTML to inject after the "logged out" message.
3675 $oldName: name of the user before logout (string)
3677 'UserMailerChangeReturnPath': Called to generate a VERP return address
3678 when UserMailer sends an email, with a bounce handling extension.
3679 $to: Array of MailAddress objects for the recipients
3680 &$returnPath: The return address string
3682 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3683 to split up an email with multiple the To: field into separate emails.
3684 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3686 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3687 Extensions can block sending the email by returning false and setting $error.
3688 $to: array of MailAdresses of the targets
3689 $from: MailAddress of the sender
3690 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3691 &$error: should be set to an error message string
3693 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3694 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3695 $to: array of MailAdresses of the targets
3696 $from: MailAddress of the sender
3697 &$subject: email subject (not MIME encoded)
3698 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3699 &$body: email body (in MIME format) as a string
3700 &$error: should be set to an error message string
3702 'UserRemoveGroup': Called when removing a group; return false to override stock
3704 $user: the user object that is to have a group removed
3705 &$group: the group to be removed, can be modified
3707 'UserRequiresHTTPS': Called to determine whether a user needs
3708 to be switched to HTTPS.
3709 $user: User in question.
3710 &$https: Boolean whether $user should be switched to HTTPS.
3712 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3713 have been requested to be reset. This hook can be used to exclude certain
3714 options from being reset even when the user has requested all prefs to be reset,
3715 because certain options might be stored in the user_properties database table
3716 despite not being visible and editable via Special:Preferences.
3717 $user: the User (object) whose preferences are being reset
3718 &$newOptions: array of new (site default) preferences
3719 $options: array of the user's old preferences
3720 $resetKinds: array containing the kinds of preferences to reset
3722 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3724 &$user: user retrieving new talks messages
3725 &$talks: array of new talks page(s)
3727 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3728 After a user's group memberships are changed.
3729 &$user: User object that was changed
3730 $add: Array of strings corresponding to groups added
3731 $remove: Array of strings corresponding to groups removed
3733 'UserSaveOptions': Called just before saving user preferences/options.
3735 &$options: Options, modifiable
3737 'UserSaveSettings': Called when saving user settings.
3740 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie
3741 handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider
3742 instead. Otherwise, you can no longer count on user data being saved to cookies
3743 versus some other mechanism.
3744 Called when setting user cookies.
3746 &$session: session array, will be added to the session
3747 &$cookies: cookies array mapping cookie name to its value
3749 'UserSetEmail': Called when changing user email address.
3751 &$email: new email, change this to override new email address
3753 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3754 email authentication.
3756 &$timestamp: new timestamp, change this to override local email
3757 authentication timestamp
3759 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3760 "Foobar (Talk | Contribs | Block)".
3761 $userId: User id of the current user
3762 $userText: User name of the current user
3763 &$items: Array of user tool links as HTML fragments
3765 'UsersPagerDoBatchLookups': Called in UsersPager::doBatchLookups() to give
3766 extensions providing user group data from an alternate source a chance to add
3767 their data into the cache array so that things like global user groups are
3768 displayed correctly in Special:ListUsers.
3769 $dbr: Read-only database handle
3770 $userIds: Array of user IDs whose groups we should look up
3771 &$cache: Array of user ID -> internal user group name (e.g. 'sysop') mappings
3772 &$groups: Array of group name -> bool true mappings for members of a given user
3775 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3776 FormatMetadata::getExtendedMeta (return false means cache will be
3777 invalidated and GetExtendedMetadata hook called again).
3778 $timestamp: The timestamp metadata was generated
3779 $file: The file the metadata is for
3781 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3782 used to alter the SQL query which gets the list of wanted pages.
3783 &$wantedPages: WantedPagesPage object
3784 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3786 'WatchArticle': Before a watch is added to an article.
3787 &$user: user that will watch
3788 &$page: WikiPage object to be watched
3789 &$status: Status object to be returned if the hook returns false
3791 'WatchArticleComplete': After a watch is added to an article.
3792 &$user: user that watched
3793 &$page: WikiPage object watched
3795 'WatchedItemQueryServiceExtensions': Create a WatchedItemQueryServiceExtension.
3796 &$extensions: Add WatchedItemQueryServiceExtension objects to this array
3797 $watchedItemQueryService: Service object
3799 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3800 form, used to manipulate the list of pages or preload data based on that list.
3801 &$watchlistInfo: array of watchlisted pages in
3802 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3804 'WatchlistEditorBuildRemoveLine': when building remove lines in
3805 Special:Watchlist/edit.
3806 &$tools: array of extra links
3807 $title: Title object
3808 $redirect: whether the page is a redirect
3810 &$link: HTML link to title
3812 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3814 $router: The PathRouter instance
3816 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3817 Return false to prevent setting of the cookie.
3818 &$name: Cookie name passed to WebResponse::setcookie()
3819 &$value: Cookie value passed to WebResponse::setcookie()
3820 &$expire: Cookie expiration, as for PHP's setcookie()
3821 &$options: Options passed to WebResponse::setcookie()
3823 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3824 run a MediaWiki cli script.
3825 &$script: MediaWiki cli script path
3826 &$parameters: Array of arguments and options to the script
3827 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3830 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3831 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3832 &$qp: The list of QueryPages
3834 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3835 $row: The DB row of the entry.
3836 $title: The Title of the page where the link comes FROM
3837 $target: The Title of the page where the link goes TO
3838 &$props: Array of HTML strings to display after the title.
3840 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3841 dumps. One, and only one hook should set this, and return false.
3842 &$tables: Database tables to use in the SELECT query
3843 &$opts: Options to use for the query
3844 &$join: Join conditions
3846 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3847 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3848 specific to a content model should be provided by the respective Content's
3849 getDeletionUpdates() method.
3851 $content: the Content to generate updates for (or null, if the Content could not be loaded
3853 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3855 'WikiPageFactory': Override WikiPage class used for a title
3856 $title: Title of the page
3857 &$page: Variable to set the created WikiPage to.
3859 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3860 extra metadata to be added.
3861 $obj: The XmlDumpWriter object.
3862 &$out: The output string.
3863 $row: The database row for the page.
3864 $title: The title of the page.
3866 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3868 &$obj: The XmlDumpWriter object.
3869 &$out: The text being output.
3870 $row: The database row for the revision.
3871 $text: The revision text.
3873 More hooks might be available but undocumented, you can execute
3874 "php maintenance/findHooks.php" to find hidden ones.